CodeGen from PR 15034 in Azure/azure-rest-api-specs

change profile to profile-content in readme.typescript.md (Azure#15034)
AzureSDKAutomation · Jul 2, 2021 · f1ca1c4 · f1ca1c4
1 parent 899fc0a
commit f1ca1c4
Show file tree

Hide file tree

Showing 13 changed files with 1,461 additions and 2,028 deletions.
diff --git a/sdk/policy/arm-policy/README.md b/sdk/policy/arm-policy/README.md
@@ -1,100 +1,99 @@
 ## Azure PolicyClient SDK for JavaScript
 
-This package contains an isomorphic SDK for PolicyClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for PolicyClient.
 
 ### Currently supported environments
 
-- Node.js version 6.x.x or higher
-- Browser JavaScript
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- Latest versions of Safari, Chrome, Edge and Firefox.
 
-### How to Install
+### Prerequisites
 
+You must have an [Azure subscription](https://azure.microsoft.com/free/).
+
+### How to install
+
+To use this SDK in your project, you will need to install two packages.
+- `@azure/arm-policy` that contains the client.
+- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
+
+Install both packages using the below command:
 ```bash
-npm install @azure/arm-policy
+npm install --save @azure/arm-policy @azure/identity
 ```
+> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
+If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.
 
 ### How to use
 
-#### nodejs - client creation and getByPolicyMode dataPolicyManifests as an example written in TypeScript.
+- If you are writing a client side browser application,
+  - Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
+  - Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
+- If you are writing a server side application,
+  - [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
+  - Complete the set up steps required by the credential if any.
+  - Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.
 
-##### Install @azure/ms-rest-nodeauth
-
-- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
-
-```bash
-npm install @azure/ms-rest-nodeauth@"^3.0.0"
-```
+In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
+Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
+#### nodejs - Authentication, client creation, and getByPolicyMode dataPolicyManifests as an example written in JavaScript.
 
 ##### Sample code
 
-While the below sample uses the interactive login, other authentication options can be found in the [README.md file of @azure/ms-rest-nodeauth](https://www.npmjs.com/package/@azure/ms-rest-nodeauth) package
-
-```typescript
-const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
 const { PolicyClient } = require("@azure/arm-policy");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth
-  .interactiveLogin()
-  .then((creds) => {
-    const client = new PolicyClient(creds, subscriptionId);
-    const policyMode = "testpolicyMode";
-    client.dataPolicyManifests.getByPolicyMode(policyMode).then((result) => {
-      console.log("The result is:");
-      console.log(result);
-    });
-  })
-  .catch((err) => {
-    console.error(err);
-  });
+// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
+// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
+const creds = new DefaultAzureCredential();
+const client = new PolicyClient(creds, subscriptionId);
+const policyMode = "testpolicyMode";
+client.dataPolicyManifests.getByPolicyMode(policyMode).then((result) => {
+  console.log("The result is:");
+  console.log(result);
+}).catch((err) => {
+  console.log("An error occurred:");
+  console.error(err);
+});
 ```
 
-#### browser - Authentication, client creation and getByPolicyMode dataPolicyManifests as an example written in JavaScript.
-
-##### Install @azure/ms-rest-browserauth
+#### browser - Authentication, client creation, and getByPolicyMode dataPolicyManifests as an example written in JavaScript.
 
-```bash
-npm install @azure/ms-rest-browserauth
-```
+In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
+  - See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
+  - Note down the client Id from the previous step and use it in the browser sample below.
 
 ##### Sample code
 
-See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
-
 - index.html
 
 ```html
 <!DOCTYPE html>
 <html lang="en">
   <head>
     <title>@azure/arm-policy sample</title>
-    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
     <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
-    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
+    <script src="node_modules/@azure/identity/dist/index.js"></script>
     <script src="node_modules/@azure/arm-policy/dist/arm-policy.js"></script>
     <script type="text/javascript">
       const subscriptionId = "<Subscription_Id>";
-      const authManager = new msAuth.AuthManager({
+      // Create credentials using the `@azure/identity` package.
+      // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
+      const credential = new InteractiveBrowserCredential(
+      {
         clientId: "<client id for your Azure AD app>",
         tenant: "<optional tenant for your organization>"
       });
-      authManager.finalizeLogin().then((res) => {
-        if (!res.isLoggedIn) {
-          // may cause redirects
-          authManager.login();
-        }
-        const client = new Azure.ArmPolicy.PolicyClient(res.creds, subscriptionId);
-        const policyMode = "testpolicyMode";
-        client.dataPolicyManifests
-          .getByPolicyMode(policyMode)
-          .then((result) => {
-            console.log("The result is:");
-            console.log(result);
-          })
-          .catch((err) => {
-            console.log("An error occurred:");
-            console.error(err);
-          });
+      const client = new Azure.ArmPolicy.PolicyClient(creds, subscriptionId);
+      const policyMode = "testpolicyMode";
+      client.dataPolicyManifests.getByPolicyMode(policyMode).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>

diff --git a/sdk/policy/arm-policy/package.json b/sdk/policy/arm-policy/package.json
@@ -4,8 +4,9 @@
   "description": "PolicyClient Library with typescript type definitions for node.js and browser.",
   "version": "4.0.0",
   "dependencies": {
-    "@azure/ms-rest-azure-js": "^2.0.1",
-    "@azure/ms-rest-js": "^2.0.4",
+    "@azure/ms-rest-azure-js": "^2.1.0",
+    "@azure/ms-rest-js": "^2.2.0",
+    "@azure/core-auth": "^1.1.4",
     "tslib": "^1.10.0"
   },
   "keywords": [
@@ -20,13 +21,13 @@
   "module": "./esm/policyClient.js",
   "types": "./esm/policyClient.d.ts",
   "devDependencies": {
-    "typescript": "^3.5.3",
+    "typescript": "^3.6.0",
     "rollup": "^1.18.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.4.2",
     "uglify-js": "^3.6.0"
   },
-  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/policy/arm-policy",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/policy/arm-policy",
   "repository": {
     "type": "git",
     "url": "https://github.com/Azure/azure-sdk-for-js.git"

diff --git a/sdk/policy/arm-policy/rollup.config.js b/sdk/policy/arm-policy/rollup.config.js
@@ -7,7 +7,10 @@ import sourcemaps from "rollup-plugin-sourcemaps";
  */
 const config = {
   input: "./esm/policyClient.js",
-  external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
+  external: [
+    "@azure/ms-rest-js",
+    "@azure/ms-rest-azure-js"
+  ],
   output: {
     file: "./dist/arm-policy.js",
     format: "umd",
@@ -25,7 +28,10 @@ const config = {
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */`
   },
-  plugins: [nodeResolve({ mainFields: ["module", "main"] }), sourcemaps()]
+  plugins: [
+    nodeResolve({ mainFields: ['module', 'main'] }),
+    sourcemaps()
+  ]
 };
 
 export default config;