Arm recoveryservicesbackup v4 (#15531)

* arm-recoveryservicesbackup-v4 * arm-recoveryservicesbackup-v4 * update readme * Update sdk/recoveryservicesbackup/arm-recoveryservicesbackup/README.md Co-authored-by: Ramya Rao <[email protected]> Co-authored-by: Wei Dong <[email protected]> Co-authored-by: Ramya Rao <[email protected]>
Azure · Jun 15, 2021 · e562127 · e562127
1 parent 6eca5bc
commit e562127
Show file tree

Hide file tree

Showing 114 changed files with 14,268 additions and 5,233 deletions.
diff --git a/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/LICENSE.txt b/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Microsoft
+Copyright (c) 2021 Microsoft
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/README.md b/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/README.md
@@ -1,97 +1,115 @@
 ## Azure RecoveryServicesBackupClient SDK for JavaScript
 
-This package contains an isomorphic SDK for RecoveryServicesBackupClient.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for RecoveryServicesBackupClient.
 
 ### 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-recoveryservicesbackup` 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-recoveryservicesbackup
+npm install --save @azure/arm-recoveryservicesbackup @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 - Authentication, client creation and get privateEndpointConnection 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
+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.
 
-- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
-```bash
-npm install @azure/ms-rest-nodeauth@"^3.0.0"
-```
+#### nodejs - Authentication, client creation, and get backupResourceVaultConfigs as an example written in JavaScript.
 
 ##### Sample code
 
-```typescript
-import * as msRest from "@azure/ms-rest-js";
-import * as msRestAzure from "@azure/ms-rest-azure-js";
-import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
-import { RecoveryServicesBackupClient, RecoveryServicesBackupModels, RecoveryServicesBackupMappers } from "@azure/arm-recoveryservicesbackup";
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new RecoveryServicesBackupClient(creds, subscriptionId);
-  const vaultName = "testvaultName";
-  const resourceGroupName = "testresourceGroupName";
-  const privateEndpointConnectionName = "testprivateEndpointConnectionName";
-  client.privateEndpointConnection.get(vaultName, resourceGroupName, privateEndpointConnectionName).then((result) => {
+// 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 RecoveryServicesBackupClient(creds, subscriptionId);
+const vaultName = "testvaultName";
+const resourceGroupName = "testresourceGroupName";
+client.backupResourceVaultConfigs
+  .get(vaultName, resourceGroupName)
+  .then((result) => {
     console.log("The result is:");
     console.log(result);
+  })
+  .catch((err) => {
+    console.log("An error occurred:");
+    console.error(err);
   });
-}).catch((err) => {
-  console.error(err);
-});
 ```
 
-#### browser - Authentication, client creation and get privateEndpointConnection as an example written in JavaScript.
+#### browser - Authentication, client creation, and get backupResourceVaultConfigs as an example written in JavaScript.
 
-##### Install @azure/ms-rest-browserauth
+In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
 
-```bash
-npm install @azure/ms-rest-browserauth
-```
+- 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-recoveryservicesbackup 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-recoveryservicesbackup/dist/arm-recoveryservicesbackup.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.ArmRecoveryservicesbackup.RecoveryServicesBackupClient(res.creds, subscriptionId);
-        const vaultName = "testvaultName";
-        const resourceGroupName = "testresourceGroupName";
-        const privateEndpointConnectionName = "testprivateEndpointConnectionName";
-        client.privateEndpointConnection.get(vaultName, resourceGroupName, privateEndpointConnectionName).then((result) => {
+      const client = new Azure.ArmRecoveryservicesbackup.RecoveryServicesBackupClient(
+        creds,
+        subscriptionId
+      );
+      const vaultName = "testvaultName";
+      const resourceGroupName = "testresourceGroupName";
+      client.backupResourceVaultConfigs
+        .get(vaultName, resourceGroupName)
+        .then((result) => {
           console.log("The result is:");
           console.log(result);
-        }).catch((err) => {
+        })
+        .catch((err) => {
           console.log("An error occurred:");
           console.error(err);
         });
-      });
     </script>
   </head>
   <body></body>

diff --git a/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/package.json b/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/package.json
@@ -2,10 +2,11 @@
   "name": "@azure/arm-recoveryservicesbackup",
   "author": "Microsoft Corporation",
   "description": "RecoveryServicesBackupClient Library with typescript type definitions for node.js and browser.",
-  "version": "6.1.0",
+  "version": "7.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,7 +21,7 @@
   "module": "./esm/recoveryServicesBackupClient.js",
   "types": "./esm/recoveryServicesBackupClient.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",

diff --git a/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/rollup.config.js b/sdk/recoveryservicesbackup/arm-recoveryservicesbackup/rollup.config.js
@@ -7,10 +7,7 @@ import sourcemaps from "rollup-plugin-sourcemaps";
  */
 const config = {
   input: "./esm/recoveryServicesBackupClient.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-recoveryservicesbackup.js",
     format: "umd",
@@ -21,17 +18,14 @@ const config = {
       "@azure/ms-rest-azure-js": "msRestAzure"
     },
     banner: `/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for license information.
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
  *
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * 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;