ARM Cosmosdb (Azure#15482)

* cosmosdb-release

* cosmosdb-release

* arm-cosmosdb-v4

* arm-cosmosdb-v4

* readme update

* Update sdk/cosmosdb/arm-cosmosdb/README.md

Co-authored-by: Ramya Rao <[email protected]>

Co-authored-by: Wei Dong <[email protected]>
Co-authored-by: Ramya Rao <[email protected]>

Author: 3 people

sdk/cosmosdb/arm-cosmosdb/README.md

@@ -1,94 +1,112 @@
 ## Azure CosmosDBManagementClient SDK for JavaScript
 
-This package contains an isomorphic SDK for CosmosDBManagementClient.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for CosmosDBManagementClient.
 
 ### 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-cosmosdb` 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-cosmosdb
+npm install --save @azure/arm-cosmosdb @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 databaseAccounts 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 databaseAccounts 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 { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth.interactiveLogin().then((creds) => {
-  const client = new CosmosDBManagementClient(creds, subscriptionId);
-  const resourceGroupName = "testresourceGroupName";
-  const accountName = "testaccountName";
-  client.databaseAccounts.get(resourceGroupName, accountName).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 CosmosDBManagementClient(creds, subscriptionId);
+const resourceGroupName = "testresourceGroupName";
+const accountName = "testaccountName";
+client.databaseAccounts
+  .get(resourceGroupName, accountName)
+  .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 databaseAccounts as an example written in JavaScript.
+#### browser - Authentication, client creation, and get databaseAccounts 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-cosmosdb 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-cosmosdb/dist/arm-cosmosdb.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.ArmCosmosdb.CosmosDBManagementClient(res.creds, subscriptionId);
-        const resourceGroupName = "testresourceGroupName";
-        const accountName = "testaccountName";
-        client.databaseAccounts.get(resourceGroupName, accountName).then((result) => {
+      const client = new Azure.ArmCosmosdb.CosmosDBManagementClient(creds, subscriptionId);
+      const resourceGroupName = "testresourceGroupName";
+      const accountName = "testaccountName";
+      client.databaseAccounts
+        .get(resourceGroupName, accountName)
+        .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>

sdk/cosmosdb/arm-cosmosdb/package.json

@@ -2,10 +2,11 @@
   "name": "@azure/arm-cosmosdb",
   "author": "Microsoft Corporation",
   "description": "CosmosDBManagementClient Library with typescript type definitions for node.js and browser.",
-  "version": "13.0.0",
+  "version": "14.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/cosmosDBManagementClient.js",
   "types": "./esm/cosmosDBManagementClient.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",

sdk/cosmosdb/arm-cosmosdb/src/cosmosDBManagementClient.ts

@@ -8,9 +8,9 @@
  */
 
 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 Parameters from "./models/parameters";
 import * as operations from "./operations";
 import { CosmosDBManagementClientContext } from "./cosmosDBManagementClientContext";
 
@@ -34,28 +34,23 @@ class CosmosDBManagementClient extends CosmosDBManagementClientContext {
   tableResources: operations.TableResources;
   cassandraResources: operations.CassandraResources;
   gremlinResources: operations.GremlinResources;
-  restorableDatabaseAccounts: operations.RestorableDatabaseAccounts;
   notebookWorkspaces: operations.NotebookWorkspaces;
-  restorableSqlDatabases: operations.RestorableSqlDatabases;
-  restorableSqlContainers: operations.RestorableSqlContainers;
-  restorableSqlResources: operations.RestorableSqlResources;
-  restorableMongodbDatabases: operations.RestorableMongodbDatabases;
-  restorableMongodbCollections: operations.RestorableMongodbCollections;
-  restorableMongodbResources: operations.RestorableMongodbResources;
-  cassandraClusters: operations.CassandraClusters;
-  cassandraDataCenters: operations.CassandraDataCenters;
   privateLinkResources: operations.PrivateLinkResources;
   privateEndpointConnections: operations.PrivateEndpointConnections;
-  service: operations.Service;
 
   /**
    * Initializes a new instance of the CosmosDBManagementClient 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 ID of the target subscription.
    * @param [options] The parameter options
    */
   constructor(
-    credentials: msRest.ServiceClientCredentials,
+    credentials: msRest.ServiceClientCredentials | TokenCredential,
     subscriptionId: string,
     options?: Models.CosmosDBManagementClientOptions
   ) {
@@ -78,128 +73,13 @@ class CosmosDBManagementClient extends CosmosDBManagementClientContext {
     this.tableResources = new operations.TableResources(this);
     this.cassandraResources = new operations.CassandraResources(this);
     this.gremlinResources = new operations.GremlinResources(this);
-    this.restorableDatabaseAccounts = new operations.RestorableDatabaseAccounts(this);
     this.notebookWorkspaces = new operations.NotebookWorkspaces(this);
-    this.restorableSqlDatabases = new operations.RestorableSqlDatabases(this);
-    this.restorableSqlContainers = new operations.RestorableSqlContainers(this);
-    this.restorableSqlResources = new operations.RestorableSqlResources(this);
-    this.restorableMongodbDatabases = new operations.RestorableMongodbDatabases(this);
-    this.restorableMongodbCollections = new operations.RestorableMongodbCollections(this);
-    this.restorableMongodbResources = new operations.RestorableMongodbResources(this);
-    this.cassandraClusters = new operations.CassandraClusters(this);
-    this.cassandraDataCenters = new operations.CassandraDataCenters(this);
     this.privateLinkResources = new operations.PrivateLinkResources(this);
     this.privateEndpointConnections = new operations.PrivateEndpointConnections(this);
-    this.service = new operations.Service(this);
-  }
-
-  /**
-   * List Cosmos DB locations and their properties
-   * @param [options] The optional parameters
-   * @returns Promise<Models.LocationListResponse>
-   */
-  locationList(options?: msRest.RequestOptionsBase): Promise<Models.LocationListResponse>;
-  /**
-   * @param callback The callback
-   */
-  locationList(callback: msRest.ServiceCallback<Models.LocationListResult>): void;
-  /**
-   * @param options The optional parameters
-   * @param callback The callback
-   */
-  locationList(
-    options: msRest.RequestOptionsBase,
-    callback: msRest.ServiceCallback<Models.LocationListResult>
-  ): void;
-  locationList(
-    options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.LocationListResult>,
-    callback?: msRest.ServiceCallback<Models.LocationListResult>
-  ): Promise<Models.LocationListResponse> {
-    return this.sendOperationRequest(
-      {
-        options
-      },
-      locationListOperationSpec,
-      callback
-    ) as Promise<Models.LocationListResponse>;
-  }
-
-  /**
-   * Get the properties of an existing Cosmos DB location
-   * @param location Cosmos DB region, with spaces between words and each word capitalized.
-   * @param [options] The optional parameters
-   * @returns Promise<Models.LocationGetResponse>
-   */
-  locationGet(
-    location: string,
-    options?: msRest.RequestOptionsBase
-  ): Promise<Models.LocationGetResponse>;
-  /**
-   * @param location Cosmos DB region, with spaces between words and each word capitalized.
-   * @param callback The callback
-   */
-  locationGet(location: string, callback: msRest.ServiceCallback<Models.LocationGetResult>): void;
-  /**
-   * @param location Cosmos DB region, with spaces between words and each word capitalized.
-   * @param options The optional parameters
-   * @param callback The callback
-   */
-  locationGet(
-    location: string,
-    options: msRest.RequestOptionsBase,
-    callback: msRest.ServiceCallback<Models.LocationGetResult>
-  ): void;
-  locationGet(
-    location: string,
-    options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.LocationGetResult>,
-    callback?: msRest.ServiceCallback<Models.LocationGetResult>
-  ): Promise<Models.LocationGetResponse> {
-    return this.sendOperationRequest(
-      {
-        location,
-        options
-      },
-      locationGetOperationSpec,
-      callback
-    ) as Promise<Models.LocationGetResponse>;
   }
 }
 
 // Operation Specifications
-const serializer = new msRest.Serializer(Mappers);
-const locationListOperationSpec: msRest.OperationSpec = {
-  httpMethod: "GET",
-  path: "subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations",
-  urlParameters: [Parameters.subscriptionId],
-  queryParameters: [Parameters.apiVersion],
-  headerParameters: [Parameters.acceptLanguage],
-  responses: {
-    200: {
-      bodyMapper: Mappers.LocationListResult
-    },
-    default: {
-      bodyMapper: Mappers.CloudError
-    }
-  },
-  serializer
-};
-
-const locationGetOperationSpec: msRest.OperationSpec = {
-  httpMethod: "GET",
-  path: "subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}",
-  urlParameters: [Parameters.subscriptionId, Parameters.location],
-  queryParameters: [Parameters.apiVersion],
-  headerParameters: [Parameters.acceptLanguage],
-  responses: {
-    200: {
-      bodyMapper: Mappers.LocationGetResult
-    },
-    default: {
-      bodyMapper: Mappers.CloudError
-    }
-  },
-  serializer
-};
 
 export {
   CosmosDBManagementClient,

sdk/cosmosdb/arm-cosmosdb/src/cosmosDBManagementClientContext.ts

@@ -10,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-cosmosdb";
-const packageVersion = "13.0.0";
+const packageVersion = "14.0.0";
 
 export class CosmosDBManagementClientContext extends msRestAzure.AzureServiceClient {
-  credentials: msRest.ServiceClientCredentials;
+  credentials: msRest.ServiceClientCredentials | TokenCredential;
   apiVersion?: string;
   subscriptionId: string;
 
   /**
    * Initializes a new instance of the CosmosDBManagementClient 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 ID of the target subscription.
    * @param [options] The parameter options
    */
   constructor(
-    credentials: msRest.ServiceClientCredentials,
+    credentials: msRest.ServiceClientCredentials | TokenCredential,
     subscriptionId: string,
     options?: Models.CosmosDBManagementClientOptions
   ) {
@@ -47,7 +53,7 @@ export class CosmosDBManagementClientContext extends msRestAzure.AzureServiceCli
 
     super(credentials, options);
 
-    this.apiVersion = "2021-04-01-preview";
+    this.apiVersion = "2021-05-15";
     this.acceptLanguage = "en-US";
     this.longRunningOperationRetryTimeout = 30;
     this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";