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

Merge 864f1674e9451bb110e645c571e265ffabc16d0e into 7601061bfbb72b2f19cb29c46cbf9a397c2d8893

sdk/iotcentral/arm-iotcentral/README.md

@@ -1,93 +1,101 @@
 ## Azure IotCentralClient SDK for JavaScript
 
-This package contains an isomorphic SDK for IotCentralClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for IotCentralClient.
 
 ### 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-iotcentral` 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-iotcentral
+npm install --save @azure/arm-iotcentral @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 get apps 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 apps 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 { IotCentralClient } = require("@azure/arm-iotcentral");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new IotCentralClient(creds, subscriptionId);
-  const resourceGroupName = "testresourceGroupName";
-  const resourceName = "testresourceName";
-  client.apps.get(resourceGroupName, resourceName).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 IotCentralClient(creds, subscriptionId);
+const resourceGroupName = "testresourceGroupName";
+const resourceName = "testresourceName";
+client.apps.get(resourceGroupName, resourceName).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 apps as an example written in JavaScript.
+#### browser - Authentication, client creation, and get apps 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-iotcentral 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-iotcentral/dist/arm-iotcentral.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.ArmIotcentral.IotCentralClient(res.creds, subscriptionId);
-        const resourceGroupName = "testresourceGroupName";
-        const resourceName = "testresourceName";
-        client.apps.get(resourceGroupName, resourceName).then((result) => {
-          console.log("The result is:");
-          console.log(result);
-        }).catch((err) => {
-          console.log("An error occurred:");
-          console.error(err);
-        });
+      const client = new Azure.ArmIotcentral.IotCentralClient(creds, subscriptionId);
+      const resourceGroupName = "testresourceGroupName";
+      const resourceName = "testresourceName";
+      client.apps.get(resourceGroupName, resourceName).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>

sdk/iotcentral/arm-iotcentral/package.json

@@ -4,8 +4,9 @@
   "description": "IotCentralClient Library with typescript type definitions for node.js and browser.",
   "version": "4.1.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/iotCentralClient.js",
   "types": "./esm/iotCentralClient.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/iotcentral/arm-iotcentral",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/iotcentral/arm-iotcentral",
   "repository": {
     "type": "git",
     "url": "https://github.com/Azure/azure-sdk-for-js.git"

sdk/iotcentral/arm-iotcentral/src/iotCentralClient.ts

@@ -8,6 +8,7 @@
  */
 
 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";
@@ -21,11 +22,16 @@ class IotCentralClient extends IotCentralClientContext {
 
   /**
    * Initializes a new instance of the IotCentralClient class.
-   * @param credentials Credentials needed for the client to connect to Azure.
+   * @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 subscription identifier.
    * @param [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.IotCentralClientOptions) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.IotCentralClientOptions) {
     super(credentials, subscriptionId, options);
     this.apps = new operations.Apps(this);
     this.operations = new operations.Operations(this);

sdk/iotcentral/arm-iotcentral/src/iotCentralClientContext.ts

@@ -10,22 +10,28 @@
 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-iotcentral";
 const packageVersion = "4.1.0";
 
 export class IotCentralClientContext extends msRestAzure.AzureServiceClient {
-  credentials: msRest.ServiceClientCredentials;
+  credentials: msRest.ServiceClientCredentials | TokenCredential;
   subscriptionId: string;
   apiVersion?: string;
 
   /**
    * Initializes a new instance of the IotCentralClient class.
-   * @param credentials Credentials needed for the client to connect to Azure.
+   * @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 subscription identifier.
    * @param [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.IotCentralClientOptions) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.IotCentralClientOptions) {
     if (credentials == undefined) {
       throw new Error('\'credentials\' cannot be null.');
     }
@@ -43,7 +49,7 @@ export class IotCentralClientContext extends msRestAzure.AzureServiceClient {
 
     super(credentials, options);
 
-    this.apiVersion = '2018-09-01';
+    this.apiVersion = '2021-06-01';
     this.acceptLanguage = 'en-US';
     this.longRunningOperationRetryTimeout = 30;
     this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";

sdk/iotcentral/arm-iotcentral/src/models/index.ts

@@ -16,7 +16,7 @@ export { BaseResource, CloudError };
  */
 export interface AppSkuInfo {
   /**
-   * The name of the SKU. Possible values include: 'F1', 'S1', 'ST0', 'ST1', 'ST2'
+   * The name of the SKU. Possible values include: 'ST0', 'ST1', 'ST2'
    */
   name: AppSku;
 }
@@ -73,6 +73,10 @@ export interface App extends Resource {
    * allows the application to be defined from scratch.
    */
   template?: string;
+  /**
+   * The current state of the application. Possible values include: 'created', 'suspended'
+   */
+  state?: AppState;
   /**
    * A valid instance SKU.
    */
@@ -110,6 +114,10 @@ export interface AppPatch {
    * allows the application to be defined from scratch.
    */
   template?: string;
+  /**
+   * The current state of the application. Possible values include: 'created', 'suspended'
+   */
+  state?: AppState;
 }
 
 /**
@@ -330,13 +338,21 @@ export interface OperationListResult extends Array<Operation> {
   nextLink?: string;
 }
 
+/**
+ * Defines values for AppState.
+ * Possible values include: 'created', 'suspended'
+ * @readonly
+ * @enum {string}
+ */
+export type AppState = 'created' | 'suspended';
+
 /**
  * Defines values for AppSku.
- * Possible values include: 'F1', 'S1', 'ST0', 'ST1', 'ST2'
+ * Possible values include: 'ST0', 'ST1', 'ST2'
  * @readonly
  * @enum {string}
  */
-export type AppSku = 'F1' | 'S1' | 'ST0' | 'ST1' | 'ST2';
+export type AppSku = 'ST0' | 'ST1' | 'ST2';
 
 /**
  * Contains response data for the get operation.

sdk/iotcentral/arm-iotcentral/src/models/mappers.ts

@@ -113,6 +113,12 @@ export const App: msRest.CompositeMapper = {
           name: "String"
         }
       },
+      state: {
+        serializedName: "properties.state",
+        type: {
+          name: "String"
+        }
+      },
       sku: {
         required: true,
         serializedName: "sku",
@@ -173,6 +179,12 @@ export const AppPatch: msRest.CompositeMapper = {
         type: {
           name: "String"
         }
+      },
+      state: {
+        serializedName: "properties.state",
+        type: {
+          name: "String"
+        }
       }
     }
   }

sdk/iotcentral/arm-iotcentral/src/operations/operations.ts

@@ -26,7 +26,7 @@ export class Operations {
   }
 
   /**
-   * Lists all of the available IoT Central application REST API operations.
+   * Lists all of the available IoT Central Resource Provider operations.
    * @param [options] The optional parameters
    * @returns Promise<Models.OperationsListResponse>
    */
@@ -50,7 +50,7 @@ export class Operations {
   }
 
   /**
-   * Lists all of the available IoT Central application REST API operations.
+   * Lists all of the available IoT Central Resource Provider operations.
    * @param nextPageLink The NextLink from the previous successful call to List operation.
    * @param [options] The optional parameters
    * @returns Promise<Models.OperationsListNextResponse>