diff --git a/sdk/reservations/arm-reservations/README.md b/sdk/reservations/arm-reservations/README.md
index 156ab2e58ad8..0e5eb07ebc3c 100644
--- a/sdk/reservations/arm-reservations/README.md
+++ b/sdk/reservations/arm-reservations/README.md
@@ -1,94 +1,107 @@
## Azure AzureReservationAPI SDK for JavaScript
-This package contains an isomorphic SDK for AzureReservationAPI.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for AzureReservationAPI.
### 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-reservations` 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-reservations
+npm install --save @azure/arm-reservations @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 quota 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 quota as an example written in JavaScript.
##### Sample code
```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
const { AzureReservationAPI } = require("@azure/arm-reservations");
-const { interactiveLogin } = require("@azure/ms-rest-nodeauth");
-
-interactiveLogin().then((creds) => {
- const client = new AzureReservationAPI(creds);
- const subscriptionId = "testsubscriptionId";
- const providerId = "testproviderId";
- const location = "westus";
- const resourceName = "testresourceName";
- client.quota.get(subscriptionId, providerId, location, resourceName).then((result) => {
- console.log("The result is:");
- console.log(result);
- });
+const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
+
+// 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 AzureReservationAPI(creds, subscriptionId);
+const testSubscriptionId = "testsubscriptionId";
+const providerId = "testproviderId";
+const location = "westus";
+const resourceName = "testresourceName";
+client.quota.get(testSubscriptionId, providerId, location, 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 quota as an example written in JavaScript.
+#### browser - Authentication, client creation, and get quota 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
@azure/arm-reservations sample
-
-
+
diff --git a/sdk/reservations/arm-reservations/package.json b/sdk/reservations/arm-reservations/package.json
index 3ed3ffb6d440..30a5d2de2c52 100644
--- a/sdk/reservations/arm-reservations/package.json
+++ b/sdk/reservations/arm-reservations/package.json
@@ -2,10 +2,11 @@
"name": "@azure/arm-reservations",
"author": "Microsoft Corporation",
"description": "AzureReservationAPI Library with typescript type definitions for node.js and browser.",
- "version": "6.0.0",
+ "version": "6.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,7 +21,7 @@
"module": "./esm/azureReservationAPI.js",
"types": "./esm/azureReservationAPI.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/reservations/arm-reservations/src/azureReservationAPI.ts b/sdk/reservations/arm-reservations/src/azureReservationAPI.ts
index 6f761cb07da8..93f338093fde 100644
--- a/sdk/reservations/arm-reservations/src/azureReservationAPI.ts
+++ b/sdk/reservations/arm-reservations/src/azureReservationAPI.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 Parameters from "./models/parameters";
@@ -27,10 +28,15 @@ class AzureReservationAPI extends AzureReservationAPIContext {
/**
* Initializes a new instance of the AzureReservationAPI 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 [options] The parameter options
*/
- constructor(credentials: msRest.ServiceClientCredentials, options?: Models.AzureReservationAPIOptions) {
+ constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, options?: Models.AzureReservationAPIOptions) {
super(credentials, options);
this.reservation = new operations.Reservation(this);
this.reservationOrder = new operations.ReservationOrder(this);
diff --git a/sdk/reservations/arm-reservations/src/azureReservationAPIContext.ts b/sdk/reservations/arm-reservations/src/azureReservationAPIContext.ts
index 49da34adf76d..e068f355fc82 100644
--- a/sdk/reservations/arm-reservations/src/azureReservationAPIContext.ts
+++ b/sdk/reservations/arm-reservations/src/azureReservationAPIContext.ts
@@ -9,20 +9,26 @@
import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
+import { TokenCredential } from "@azure/core-auth";
import * as msRestAzure from "@azure/ms-rest-azure-js";
const packageName = "@azure/arm-reservations";
-const packageVersion = "6.0.0";
+const packageVersion = "6.1.0";
export class AzureReservationAPIContext extends msRestAzure.AzureServiceClient {
- credentials: msRest.ServiceClientCredentials;
+ credentials: msRest.ServiceClientCredentials | TokenCredential;
/**
* Initializes a new instance of the AzureReservationAPI 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 [options] The parameter options
*/
- constructor(credentials: msRest.ServiceClientCredentials, options?: Models.AzureReservationAPIOptions) {
+ constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, options?: Models.AzureReservationAPIOptions) {
if (credentials == undefined) {
throw new Error('\'credentials\' cannot be null.');
}
diff --git a/sdk/subscription/arm-subscriptions/README.md b/sdk/subscription/arm-subscriptions/README.md
index e57ebc12be19..2b3b9e76e8c9 100644
--- a/sdk/subscription/arm-subscriptions/README.md
+++ b/sdk/subscription/arm-subscriptions/README.md
@@ -1,92 +1,101 @@
## Azure SubscriptionClient SDK for JavaScript
-This package contains an isomorphic SDK for SubscriptionClient.
+This package contains an isomorphic SDK (runs both in Node.js and in browsers) for SubscriptionClient.
### 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-subscriptions` 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-subscriptions
+npm install --save @azure/arm-subscriptions @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 listLocations subscriptions 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 listLocations subscriptions 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 { SubscriptionClient, SubscriptionModels, SubscriptionMappers } from "@azure/arm-subscriptions";
+```javascript
+const { DefaultAzureCredential } = require("@azure/identity");
+const { SubscriptionClient } = require("@azure/arm-subscriptions");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
-msRestNodeAuth.interactiveLogin().then((creds) => {
- const client = new SubscriptionClient(creds, subscriptionId);
- const subscriptionId = "testsubscriptionId";
- client.subscriptions.listLocations(subscriptionId).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 SubscriptionClient(creds, subscriptionId);
+const testSubscriptionId = "testsubscriptionId";
+client.subscriptions.listLocations(testSubscriptionId).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 listLocations subscriptions as an example written in JavaScript.
+#### browser - Authentication, client creation, and listLocations subscriptions 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
@azure/arm-subscriptions sample
-
-
+
diff --git a/sdk/subscription/arm-subscriptions/package.json b/sdk/subscription/arm-subscriptions/package.json
index 6f56ecd0b90b..496e84d39a30 100644
--- a/sdk/subscription/arm-subscriptions/package.json
+++ b/sdk/subscription/arm-subscriptions/package.json
@@ -2,10 +2,11 @@
"name": "@azure/arm-subscriptions",
"author": "Microsoft Corporation",
"description": "SubscriptionClient Library with typescript type definitions for node.js and browser.",
- "version": "3.0.0",
+ "version": "3.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,7 +21,7 @@
"module": "./esm/subscriptionClient.js",
"types": "./esm/subscriptionClient.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/subscription/arm-subscriptions/src/subscriptionClient.ts b/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts
index e09ea265f1f4..1422cd860dec 100644
--- a/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts
+++ b/sdk/subscription/arm-subscriptions/src/subscriptionClient.ts
@@ -9,6 +9,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";
@@ -25,10 +26,15 @@ class SubscriptionClient extends SubscriptionClientContext {
/**
* Initializes a new instance of the SubscriptionClient 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 [options] The parameter options
*/
- constructor(credentials: msRest.ServiceClientCredentials, options?: Models.SubscriptionClientOptions) {
+ constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, options?: Models.SubscriptionClientOptions) {
super(credentials, options);
this.subscriptions = new operations.Subscriptions(this);
this.tenants = new operations.Tenants(this);
diff --git a/sdk/subscription/arm-subscriptions/src/subscriptionClientContext.ts b/sdk/subscription/arm-subscriptions/src/subscriptionClientContext.ts
index e04e4ea0027c..3971cb1fd930 100644
--- a/sdk/subscription/arm-subscriptions/src/subscriptionClientContext.ts
+++ b/sdk/subscription/arm-subscriptions/src/subscriptionClientContext.ts
@@ -10,20 +10,26 @@
import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
+import { TokenCredential } from "@azure/core-auth";
import * as msRestAzure from "@azure/ms-rest-azure-js";
const packageName = "@azure/arm-subscriptions";
-const packageVersion = "3.0.0";
+const packageVersion = "3.1.0";
export class SubscriptionClientContext extends msRestAzure.AzureServiceClient {
- credentials: msRest.ServiceClientCredentials;
+ credentials: msRest.ServiceClientCredentials | TokenCredential;
/**
* Initializes a new instance of the SubscriptionClient 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 [options] The parameter options
*/
- constructor(credentials: msRest.ServiceClientCredentials, options?: Models.SubscriptionClientOptions) {
+ constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, options?: Models.SubscriptionClientOptions) {
if (credentials == undefined) {
throw new Error('\'credentials\' cannot be null.');
}