AzureSDKAutomation · openapi-sdkautomation · Jun 7, 2021
@@ -1,111 +1,109 @@
 ## Azure ConsumptionManagementClient SDK for JavaScript
 
-This package contains an isomorphic SDK for ConsumptionManagementClient.
+This package contains an isomorphic SDK (runs both in node.js and in browsers) for ConsumptionManagementClient.
 
 ### Currently supported environments
 
-- Node.js version 6.x.x or higher
+- Node.js version 8.x.x or higher
 - Browser JavaScript
 
-### 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-consumption` 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-consumption
+npm install --save @azure/arm-consumption @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 list usageDetails 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 list usageDetails 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 { ConsumptionManagementClient } = require("@azure/arm-consumption");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
-msRestNodeAuth
-  .interactiveLogin()
-  .then((creds) => {
-    const client = new ConsumptionManagementClient(creds, subscriptionId);
-    const expand = "testexpand";
-    const filter = "testfilter";
-    const skiptoken = "testskiptoken";
-    const top = 1;
-    const apply = "testapply";
-    client.usageDetails.list(expand, filter, skiptoken, top, apply).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 ConsumptionManagementClient(creds, subscriptionId);
+const scope = "testscope";
+const expand = "testexpand";
+const filter = "testfilter";
+const skiptoken = "testskiptoken";
+const top = 1;
+const metric = "actualcost";
+client.usageDetails.list(scope, expand, filter, skiptoken, top, metric).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 list usageDetails as an example written in JavaScript.
-
-##### Install @azure/ms-rest-browserauth
+#### browser - Authentication, client creation, and list usageDetails 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-consumption 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-consumption/dist/arm-consumption.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.ArmConsumption.ConsumptionManagementClient(
-          res.creds,
-          subscriptionId
-        );
-        const expand = "testexpand";
-        const filter = "testfilter";
-        const skiptoken = "testskiptoken";
-        const top = 1;
-        const apply = "testapply";
-        client.usageDetails
-          .list(expand, filter, skiptoken, top, apply)
-          .then((result) => {
-            console.log("The result is:");
-            console.log(result);
-          })
-          .catch((err) => {
-            console.log("An error occurred:");
-            console.error(err);
-          });
+      const client = new Azure.ArmConsumption.ConsumptionManagementClient(creds, subscriptionId);
+      const scope = "testscope";
+      const expand = "testexpand";
+      const filter = "testfilter";
+      const skiptoken = "testskiptoken";
+      const top = 1;
+      const metric = "actualcost";
+      client.usageDetails.list(scope, expand, filter, skiptoken, top, metric).then((result) => {
+        console.log("The result is:");
+        console.log(result);
+      }).catch((err) => {
+        console.log("An error occurred:");
+        console.error(err);
       });
     </script>
   </head>

@@ -4,8 +4,9 @@
   "description": "ConsumptionManagementClient Library with typescript type definitions for node.js and browser.",
   "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/consumptionManagementClient.js",
   "types": "./esm/consumptionManagementClient.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",

@@ -7,7 +7,10 @@ import sourcemaps from "rollup-plugin-sourcemaps";
  */
 const config = {
   input: "./esm/consumptionManagementClient.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-consumption.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;
@@ -8,54 +8,65 @@
  */
 
 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 { ConsumptionManagementClientContext } from "./consumptionManagementClientContext";
 
+
 class ConsumptionManagementClient extends ConsumptionManagementClientContext {
   // Operation groups
   usageDetails: operations.UsageDetails;
   marketplaces: operations.Marketplaces;
+  budgets: operations.Budgets;
+  tags: operations.Tags;
+  charges: operations.Charges;
   balances: operations.Balances;
   reservationsSummaries: operations.ReservationsSummaries;
   reservationsDetails: operations.ReservationsDetails;
   reservationRecommendations: operations.ReservationRecommendations;
-  budgets: operations.Budgets;
+  reservationRecommendationDetails: operations.ReservationRecommendationDetails;
+  reservationTransactions: operations.ReservationTransactions;
   priceSheet: operations.PriceSheet;
-  tags: operations.Tags;
   forecasts: operations.Forecasts;
   operations: operations.Operations;
   aggregatedCost: operations.AggregatedCost;
-  charges: operations.Charges;
-  tenants: operations.Tenants;
+  events: operations.EventsOperations;
+  lots: operations.LotsOperations;
+  credits: operations.Credits;
 
   /**
    * Initializes a new instance of the ConsumptionManagementClient 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 Azure Subscription ID.
    * @param [options] The parameter options
    */
-  constructor(
-    credentials: msRest.ServiceClientCredentials,
-    subscriptionId: string,
-    options?: Models.ConsumptionManagementClientOptions
-  ) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ConsumptionManagementClientOptions) {
     super(credentials, subscriptionId, options);
     this.usageDetails = new operations.UsageDetails(this);
     this.marketplaces = new operations.Marketplaces(this);
+    this.budgets = new operations.Budgets(this);
+    this.tags = new operations.Tags(this);
+    this.charges = new operations.Charges(this);
     this.balances = new operations.Balances(this);
     this.reservationsSummaries = new operations.ReservationsSummaries(this);
     this.reservationsDetails = new operations.ReservationsDetails(this);
     this.reservationRecommendations = new operations.ReservationRecommendations(this);
-    this.budgets = new operations.Budgets(this);
+    this.reservationRecommendationDetails = new operations.ReservationRecommendationDetails(this);
+    this.reservationTransactions = new operations.ReservationTransactions(this);
     this.priceSheet = new operations.PriceSheet(this);
-    this.tags = new operations.Tags(this);
     this.forecasts = new operations.Forecasts(this);
     this.operations = new operations.Operations(this);
     this.aggregatedCost = new operations.AggregatedCost(this);
-    this.charges = new operations.Charges(this);
-    this.tenants = new operations.Tenants(this);
+    this.events = new operations.EventsOperations(this);
+    this.lots = new operations.LotsOperations(this);
+    this.credits = new operations.Credits(this);
   }
 }
 

@@ -10,31 +10,33 @@
 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-consumption";
 const packageVersion = "7.0.0";
 
 export class ConsumptionManagementClientContext extends msRestAzure.AzureServiceClient {
-  credentials: msRest.ServiceClientCredentials;
+  credentials: msRest.ServiceClientCredentials | TokenCredential;
   apiVersion?: string;
   subscriptionId: string;
 
   /**
    * Initializes a new instance of the ConsumptionManagementClient 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 Azure Subscription ID.
    * @param [options] The parameter options
    */
-  constructor(
-    credentials: msRest.ServiceClientCredentials,
-    subscriptionId: string,
-    options?: Models.ConsumptionManagementClientOptions
-  ) {
+  constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ConsumptionManagementClientOptions) {
     if (credentials == undefined) {
-      throw new Error("'credentials' cannot be null.");
+      throw new Error('\'credentials\' cannot be null.');
     }
     if (subscriptionId == undefined) {
-      throw new Error("'subscriptionId' cannot be null.");
+      throw new Error('\'subscriptionId\' cannot be null.');
     }
 
     if (!options) {
@@ -47,8 +49,8 @@ export class ConsumptionManagementClientContext extends msRestAzure.AzureService
 
     super(credentials, options);
 
-    this.apiVersion = "2018-10-01";
-    this.acceptLanguage = "en-US";
+    this.apiVersion = '2021-05-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";
@@ -58,10 +60,7 @@ export class ConsumptionManagementClientContext extends msRestAzure.AzureService
     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;
     }
   }