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

Merge c8d83ee70179db7f983655430629ea7ca888387b into 0f72d7e8267d012ed7f51107f066217c8bfda9a7
AzureSDKAutomation · Jun 18, 2021 · 21f6227 · 21f6227
1 parent e823b26
commit 21f6227
Show file tree

Hide file tree

Showing 30 changed files with 2,121 additions and 943 deletions.
diff --git a/sdk/batch/arm-batch/LICENSE.txt b/sdk/batch/arm-batch/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/batch/arm-batch/README.md b/sdk/batch/arm-batch/README.md
@@ -1,94 +1,101 @@
-## Azure BatchManagementClient SDK for JavaScript
+## Azure BatchManagement SDK for JavaScript
 
-This package contains an isomorphic SDK for BatchManagementClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for BatchManagement.
 
 ### 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-batch` 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-batch
+npm install --save @azure/arm-batch @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 batchAccount 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 get batchAccount 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 { BatchManagementClient, BatchManagementModels, BatchManagementMappers } from "@azure/arm-batch";
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { BatchManagement } = require("@azure/arm-batch");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new BatchManagementClient(creds, subscriptionId);
-  const resourceGroupName = "testresourceGroupName";
-  const accountName = "testaccountName";
-  client.batchAccount.get(resourceGroupName, accountName).then((result) => {
-    console.log("The result is:");
-    console.log(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 BatchManagement(creds, subscriptionId);
+const resourceGroupName = "testresourceGroupName";
+const accountName = "testaccountName";
+client.batchAccount.get(resourceGroupName, accountName).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 get batchAccount as an example written in JavaScript.
+#### browser - Authentication, client creation, and get batchAccount as an example written in JavaScript.
 
-##### Install @azure/ms-rest-browserauth
-
-```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-batch 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-batch/dist/arm-batch.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.ArmBatch.BatchManagementClient(res.creds, subscriptionId);
-        const resourceGroupName = "testresourceGroupName";
-        const accountName = "testaccountName";
-        client.batchAccount.get(resourceGroupName, accountName).then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.ArmBatch.BatchManagement(creds, subscriptionId);
+      const resourceGroupName = "testresourceGroupName";
+      const accountName = "testaccountName";
+      client.batchAccount.get(resourceGroupName, accountName).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>
@@ -100,4 +107,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/README.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/batch/arm-batch/README.png)
diff --git a/sdk/batch/arm-batch/package.json b/sdk/batch/arm-batch/package.json
@@ -1,12 +1,13 @@
 {
   "name": "@azure/arm-batch",
   "author": "Microsoft Corporation",
-  "description": "BatchManagementClient Library with typescript type definitions for node.js and browser.",
+  "description": "BatchManagement Library with typescript type definitions for node.js and browser.",
   "version": "5.0.0",
   "dependencies": {
-    "@azure/ms-rest-azure-js": "^2.0.1",
-    "@azure/ms-rest-js": "^2.0.4",
-    "tslib": "^2.0.0"
+    "@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": [
     "node",
@@ -17,24 +18,16 @@
   ],
   "license": "MIT",
   "main": "./dist/arm-batch.js",
-  "module": "./esm/batchManagementClient.js",
-  "types": "./esm/batchManagementClient.d.ts",
+  "module": "./esm/batchManagement.js",
+  "types": "./esm/batchManagement.d.ts",
   "devDependencies": {
-    "@types/chai": "^4.1.6",
-    "@types/jssha": "^2.0.0",
-    "@types/mocha": "^7.0.2",
-    "chai": "^4.2.0",
-    "dotenv": "^8.2.0",
-    "mocha": "^7.1.1",
-    "rollup": "^1.16.3",
+    "typescript": "^3.6.0",
+    "rollup": "^1.18.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.4.2",
-    "esm": "^3.2.25",
-    "ts-node": "^8.3.0",
-    "typescript": "~3.9.3",
-    "uglify-js": "^3.4.9"
+    "uglify-js": "^3.6.0"
   },
-  "homepage": "https://github.com/Azure/azure-sdk-for-js",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/batch/arm-batch",
   "repository": {
     "type": "git",
     "url": "https://github.com/Azure/azure-sdk-for-js.git"
@@ -59,8 +52,7 @@
   "scripts": {
     "build": "tsc && rollup -c rollup.config.js && npm run minify",
     "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/arm-batch.js.map'\" -o ./dist/arm-batch.min.js ./dist/arm-batch.js",
-    "prepack": "npm install && npm run build",
-    "test": "mocha -r esm --require ts-node/register test/*.spec.ts --timeout 1200000 --full-trace"
+    "prepack": "npm install && npm run build"
   },
   "sideEffects": false,
   "autoPublish": true

diff --git a/sdk/batch/arm-batch/rollup.config.js b/sdk/batch/arm-batch/rollup.config.js
@@ -6,7 +6,7 @@ import sourcemaps from "rollup-plugin-sourcemaps";
  * @type {rollup.RollupFileOptions}
  */
 const config = {
-  input: "./esm/batchManagementClient.js",
+  input: "./esm/batchManagement.js",
   external: [
     "@azure/ms-rest-js",
     "@azure/ms-rest-azure-js"
@@ -21,8 +21,8 @@ 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.

diff --git a/...ch/arm-batch/src/batchManagementClient.ts → sdk/batch/arm-batch/src/batchManagement.ts b/...ch/arm-batch/src/batchManagementClient.ts → sdk/batch/arm-batch/src/batchManagement.ts
@@ -1,21 +1,21 @@
 /*
- * 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.
  */
 
 import * as msRest from "@azure/ms-rest-js";
+import { TokenCredential } from "@azure/core-auth";
 import * as Models from "./models";
 import * as Mappers from "./models/mappers";
 import * as operations from "./operations";
-import { BatchManagementClientContext } from "./batchManagementClientContext";
+import { BatchManagementContext } from "./batchManagementContext";
 
 
-class BatchManagementClient extends BatchManagementClientContext {
+class BatchManagement extends BatchManagementContext {
   // Operation groups
   batchAccount: operations.BatchAccountOperations;
   applicationPackage: operations.ApplicationPackageOperations;
@@ -28,13 +28,18 @@ class BatchManagementClient extends BatchManagementClientContext {
   pool: operations.PoolOperations;
 
   /**
-   * Initializes a new instance of the BatchManagementClient class.
-   * @param credentials Credentials needed for the client to connect to Azure.
+   * Initializes a new instance of the BatchManagement class.
+   * @param credentials Credentials needed for the client to connect to Azure. Credentials
+   * implementing the TokenCredential interface from the @azure/identity package are recommended. For
+   * more information about these credentials, see
+   * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
+   * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
+   * @azure/ms-rest-browserauth are also supported.
    * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
    * 00000000-0000-0000-0000-000000000000)
    * @param [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.BatchManagementClientOptions) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.BatchManagementOptions) {
     super(credentials, subscriptionId, options);
     this.batchAccount = new operations.BatchAccountOperations(this);
     this.applicationPackage = new operations.ApplicationPackageOperations(this);
@@ -51,8 +56,8 @@ class BatchManagementClient extends BatchManagementClientContext {
 // Operation Specifications
 
 export {
-  BatchManagementClient,
-  BatchManagementClientContext,
+  BatchManagement,
+  BatchManagementContext,
   Models as BatchManagementModels,
   Mappers as BatchManagementMappers
 };

diff --git a/...batch/src/batchManagementClientContext.ts → ...h/arm-batch/src/batchManagementContext.ts b/...batch/src/batchManagementClientContext.ts → ...h/arm-batch/src/batchManagementContext.ts
@@ -1,7 +1,6 @@
 /*
- * 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
@@ -11,23 +10,29 @@
 import * as Models from "./models";
 import * as msRest from "@azure/ms-rest-js";
 import * as msRestAzure from "@azure/ms-rest-azure-js";
+import { TokenCredential } from "@azure/core-auth";
 
 const packageName = "@azure/arm-batch";
 const packageVersion = "5.0.0";
 
-export class BatchManagementClientContext extends msRestAzure.AzureServiceClient {
-  credentials: msRest.ServiceClientCredentials;
+export class BatchManagementContext extends msRestAzure.AzureServiceClient {
+  credentials: msRest.ServiceClientCredentials | TokenCredential;
   subscriptionId: string;
   apiVersion?: string;
 
   /**
-   * Initializes a new instance of the BatchManagementClient class.
-   * @param credentials Credentials needed for the client to connect to Azure.
+   * Initializes a new instance of the BatchManagement class.
+   * @param credentials Credentials needed for the client to connect to Azure. Credentials
+   * implementing the TokenCredential interface from the @azure/identity package are recommended. For
+   * more information about these credentials, see
+   * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
+   * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
+   * @azure/ms-rest-browserauth are also supported.
    * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
    * 00000000-0000-0000-0000-000000000000)
    * @param [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.BatchManagementClientOptions) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.BatchManagementOptions) {
     if (credentials == undefined) {
       throw new Error('\'credentials\' cannot be null.');
     }
@@ -38,25 +43,25 @@ export class BatchManagementClientContext extends msRestAzure.AzureServiceClient
     if (!options) {
       options = {};
     }
-    if(!options.userAgent) {
+    if (!options.userAgent) {
       const defaultUserAgent = msRestAzure.getDefaultUserAgentValue();
       options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
     }
 
     super(credentials, options);
 
-    this.apiVersion = '2020-09-01';
+    this.apiVersion = '2021-06-01';
     this.acceptLanguage = 'en-US';
     this.longRunningOperationRetryTimeout = 30;
     this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
     this.requestContentType = "application/json; charset=utf-8";
     this.credentials = credentials;
     this.subscriptionId = subscriptionId;
 
-    if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
+    if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
       this.acceptLanguage = options.acceptLanguage;
     }
-    if(options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
+    if (options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
       this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout;
     }
   }