Skip to content

Commit d76e6f6

Browse files
colawwjcolawwj
authored
arm-support-identity-ten (Azure#15942)
1 parent bb9896d commit d76e6f6

32 files changed

+652
-468
lines changed

‎sdk/edgegateway/arm-edgegateway/README.md‎

Lines changed: 58 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,100 @@
11
## Azure DataBoxEdgeManagementClient SDK for JavaScript
22

3-
This package contains an isomorphic SDK for DataBoxEdgeManagementClient.
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for DataBoxEdgeManagementClient.
44

55
### Currently supported environments
66

7-
- Node.js version 6.x.x or higher
8-
- Browser JavaScript
7+
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
8+
- Latest versions of Safari, Chrome, Edge, and Firefox.
99

10-
### How to Install
10+
### Prerequisites
1111

12+
You must have an [Azure subscription](https://azure.microsoft.com/free/).
13+
14+
### How to install
15+
16+
To use this SDK in your project, you will need to install two packages.
17+
- `@azure/arm-edgegateway` that contains the client.
18+
- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
19+
20+
Install both packages using the below command:
1221
```bash
13-
npm install @azure/arm-edgegateway
22+
npm install --save @azure/arm-edgegateway @azure/identity
1423
```
1524

25+
> **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.
26+
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.
27+
1628
### How to use
1729

18-
#### nodejs - Authentication, client creation and list operations as an example written in TypeScript.
30+
- If you are writing a client side browser application,
31+
- 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.
32+
- 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.
33+
- If you are writing a server side application,
34+
- [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
35+
- Complete the set up steps required by the credential if any.
36+
- Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.
1937

20-
##### Install @azure/ms-rest-nodeauth
38+
In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
39+
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.
2140

22-
```bash
23-
npm install @azure/ms-rest-nodeauth
24-
```
41+
#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript.
2542

2643
##### Sample code
2744

28-
```typescript
29-
import * as msRest from "@azure/ms-rest-js";
30-
import * as msRestAzure from "@azure/ms-rest-azure-js";
31-
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
32-
import { DataBoxEdgeManagementClient, DataBoxEdgeManagementModels, DataBoxEdgeManagementMappers } from "@azure/arm-edgegateway";
45+
```javascript
46+
const { DefaultAzureCredential } = require("@azure/identity");
47+
const { DataBoxEdgeManagementClient } = require("@azure/arm-edgegateway");
3348
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
3449

35-
msRestNodeAuth.interactiveLogin().then((creds) => {
36-
const client = new DataBoxEdgeManagementClient(creds, subscriptionId);
37-
client.operations.list().then((result) => {
38-
console.log("The result is:");
39-
console.log(result);
40-
});
50+
// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
51+
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
52+
const creds = new DefaultAzureCredential();
53+
const client = new DataBoxEdgeManagementClient(creds, subscriptionId);
54+
55+
client.operations.list().then((result) => {
56+
console.log("The result is:");
57+
console.log(result);
4158
}).catch((err) => {
59+
console.log("An error occurred:");
4260
console.error(err);
4361
});
4462
```
4563

46-
#### browser - Authentication, client creation and list operations as an example written in JavaScript.
47-
48-
##### Install @azure/ms-rest-browserauth
64+
#### browser - Authentication, client creation, and list operations as an example written in JavaScript.
4965

50-
```bash
51-
npm install @azure/ms-rest-browserauth
52-
```
66+
In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
67+
- 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.
68+
- Note down the client Id from the previous step and use it in the browser sample below.
5369

5470
##### Sample code
5571

56-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
57-
5872
- index.html
73+
5974
```html
6075
<!DOCTYPE html>
6176
<html lang="en">
6277
<head>
6378
<title>@azure/arm-edgegateway sample</title>
64-
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
6579
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
66-
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
80+
<script src="node_modules/@azure/identity/dist/index.js"></script>
6781
<script src="node_modules/@azure/arm-edgegateway/dist/arm-edgegateway.js"></script>
6882
<script type="text/javascript">
6983
const subscriptionId = "<Subscription_Id>";
70-
const authManager = new msAuth.AuthManager({
84+
// Create credentials using the `@azure/identity` package.
85+
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
86+
const credential = new InteractiveBrowserCredential(
87+
{
7188
clientId: "<client id for your Azure AD app>",
72-
tenant: "<optional tenant for your organization>"
89+
tenantId: "<optional tenant for your organization>"
7390
});
74-
authManager.finalizeLogin().then((res) => {
75-
if (!res.isLoggedIn) {
76-
// may cause redirects
77-
authManager.login();
78-
}
79-
const client = new Azure.ArmEdgegateway.DataBoxEdgeManagementClient(res.creds, subscriptionId);
80-
client.operations.list().then((result) => {
81-
console.log("The result is:");
82-
console.log(result);
83-
}).catch((err) => {
84-
console.log("An error occurred:");
85-
console.error(err);
86-
});
91+
const client = new Azure.ArmEdgegateway.DataBoxEdgeManagementClient(creds, subscriptionId);
92+
client.operations.list().then((result) => {
93+
console.log("The result is:");
94+
console.log(result);
95+
}).catch((err) => {
96+
console.log("An error occurred:");
97+
console.error(err);
8798
});
8899
</script>
89100
</head>
@@ -95,4 +106,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to
95106

96107
- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
97108

98-
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fedgegateway%2Farm-edgegateway%2FREADME.png)
109+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/edgegateway/arm-edgegateway/README.png)

‎sdk/edgegateway/arm-edgegateway/package.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
"name": "@azure/arm-edgegateway",
33
"author": "Microsoft Corporation",
44
"description": "DataBoxEdgeManagementClient Library with typescript type definitions for node.js and browser.",
5-
"version": "2.0.1",
5+
"version": "2.1.0",
66
"dependencies": {
7-
"@azure/ms-rest-azure-js": "^2.0.0",
8-
"@azure/ms-rest-js": "^2.0.3",
7+
"@azure/ms-rest-azure-js": "^2.1.0",
8+
"@azure/ms-rest-js": "^2.2.0",
9+
"@azure/core-auth": "^1.1.4",
910
"tslib": "^1.10.0"
1011
},
1112
"keywords": [
@@ -20,7 +21,7 @@
2021
"module": "./esm/dataBoxEdgeManagementClient.js",
2122
"types": "./esm/dataBoxEdgeManagementClient.d.ts",
2223
"devDependencies": {
23-
"typescript": "^3.1.1",
24+
"typescript": "^3.6.0",
2425
"rollup": "^0.66.2",
2526
"rollup-plugin-node-resolve": "^3.4.0",
2627
"rollup-plugin-sourcemaps": "^0.4.2",

‎sdk/edgegateway/arm-edgegateway/src/dataBoxEdgeManagementClient.ts‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
*/
1010

1111
import * as msRest from "@azure/ms-rest-js";
12+
import { TokenCredential } from "@azure/core-auth";
1213
import * as Models from "./models";
1314
import * as Mappers from "./models/mappers";
1415
import * as operations from "./operations";
@@ -32,11 +33,16 @@ class DataBoxEdgeManagementClient extends DataBoxEdgeManagementClientContext {
3233

3334
/**
3435
* Initializes a new instance of the DataBoxEdgeManagementClient class.
35-
* @param credentials Credentials needed for the client to connect to Azure.
36+
* @param credentials Credentials needed for the client to connect to Azure. Credentials
37+
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
38+
* more information about these credentials, see
39+
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
40+
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
41+
* @azure/ms-rest-browserauth are also supported.
3642
* @param subscriptionId The subscription ID.
3743
* @param [options] The parameter options
3844
*/
39-
constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.DataBoxEdgeManagementClientOptions) {
45+
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.DataBoxEdgeManagementClientOptions) {
4046
super(credentials, subscriptionId, options);
4147
this.operations = new operations.Operations(this);
4248
this.devices = new operations.Devices(this);

‎sdk/edgegateway/arm-edgegateway/src/dataBoxEdgeManagementClientContext.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,29 @@
1010

1111
import * as Models from "./models";
1212
import * as msRest from "@azure/ms-rest-js";
13+
import { TokenCredential } from "@azure/core-auth";
1314
import * as msRestAzure from "@azure/ms-rest-azure-js";
1415

1516
const packageName = "@azure/arm-edgegateway";
16-
const packageVersion = "2.0.1";
17+
const packageVersion = "2.1.0";
1718

1819
export class DataBoxEdgeManagementClientContext extends msRestAzure.AzureServiceClient {
19-
credentials: msRest.ServiceClientCredentials;
20+
credentials: msRest.ServiceClientCredentials | TokenCredential;
2021
apiVersion?: string;
2122
subscriptionId: string;
2223

2324
/**
2425
* Initializes a new instance of the DataBoxEdgeManagementClient class.
25-
* @param credentials Credentials needed for the client to connect to Azure.
26+
* @param credentials Credentials needed for the client to connect to Azure. Credentials
27+
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
28+
* more information about these credentials, see
29+
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
30+
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
31+
* @azure/ms-rest-browserauth are also supported.
2632
* @param subscriptionId The subscription ID.
2733
* @param [options] The parameter options
2834
*/
29-
constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.DataBoxEdgeManagementClientOptions) {
35+
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.DataBoxEdgeManagementClientOptions) {
3036
if (credentials == undefined) {
3137
throw new Error('\'credentials\' cannot be null.');
3238
}

‎sdk/eventhub/arm-eventhub-profile-2020-09-01-hybrid/README.md‎

Lines changed: 57 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,100 @@
11
## Azure EventHubManagementClient SDK for JavaScript
22

3-
This package contains an isomorphic SDK for EventHubManagementClient.
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for EventHubManagementClient.
44

55
### Currently supported environments
66

7-
- Node.js version 6.x.x or higher
8-
- Browser JavaScript
7+
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
8+
- Latest versions of Safari, Chrome, Edge, and Firefox.
99

10-
### How to Install
10+
### Prerequisites
1111

12+
You must have an [Azure subscription](https://azure.microsoft.com/free/).
13+
14+
### How to install
15+
16+
To use this SDK in your project, you will need to install two packages.
17+
- `@azure/arm-eventhub-profile-2020-09-01-hybrid` that contains the client.
18+
- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.
19+
20+
Install both packages using the below command:
1221
```bash
13-
npm install @azure/arm-eventhub-profile-2020-09-01-hybrid
22+
npm install --save @azure/arm-eventhub-profile-2020-09-01-hybrid @azure/identity
1423
```
1524

25+
> **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.
26+
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.
27+
1628
### How to use
1729

18-
#### nodejs - Authentication, client creation and listAvailableClusterRegion clusters as an example written in TypeScript.
30+
- If you are writing a client side browser application,
31+
- 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.
32+
- 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.
33+
- If you are writing a server side application,
34+
- [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
35+
- Complete the set up steps required by the credential if any.
36+
- Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.
1937

20-
##### Install @azure/ms-rest-nodeauth
38+
In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
39+
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.
2140

22-
- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
23-
```bash
24-
npm install @azure/ms-rest-nodeauth@"^3.0.0"
25-
```
41+
#### nodejs - Authentication, client creation, and listAvailableClusterRegion clusters as an example written in JavaScript.
2642

2743
##### Sample code
2844

29-
```typescript
30-
import * as msRest from "@azure/ms-rest-js";
31-
import * as msRestAzure from "@azure/ms-rest-azure-js";
32-
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
33-
import { EventHubManagementClient, EventHubManagementModels, EventHubManagementMappers } from "@azure/arm-eventhub-profile-2020-09-01-hybrid";
45+
```javascript
46+
const { DefaultAzureCredential } = require("@azure/identity");
47+
const { EventHubManagementClient } = require("@azure/arm-eventhub-profile-2020-09-01-hybrid");
3448
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
3549

36-
msRestNodeAuth.interactiveLogin().then((creds) => {
37-
const client = new EventHubManagementClient(creds, subscriptionId);
38-
client.clusters.listAvailableClusterRegion().then((result) => {
39-
console.log("The result is:");
40-
console.log(result);
41-
});
50+
// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
51+
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
52+
const creds = new DefaultAzureCredential();
53+
const client = new EventHubManagementClient(creds, subscriptionId);
54+
55+
client.clusters.listAvailableClusterRegion().then((result) => {
56+
console.log("The result is:");
57+
console.log(result);
4258
}).catch((err) => {
59+
console.log("An error occurred:");
4360
console.error(err);
4461
});
4562
```
4663

47-
#### browser - Authentication, client creation and listAvailableClusterRegion clusters as an example written in JavaScript.
48-
49-
##### Install @azure/ms-rest-browserauth
64+
#### browser - Authentication, client creation, and listAvailableClusterRegion clusters as an example written in JavaScript.
5065

51-
```bash
52-
npm install @azure/ms-rest-browserauth
53-
```
66+
In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
67+
- 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.
68+
- Note down the client Id from the previous step and use it in the browser sample below.
5469

5570
##### Sample code
5671

57-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
58-
5972
- index.html
73+
6074
```html
6175
<!DOCTYPE html>
6276
<html lang="en">
6377
<head>
6478
<title>@azure/arm-eventhub-profile-2020-09-01-hybrid sample</title>
65-
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
6679
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
67-
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
80+
<script src="node_modules/@azure/identity/dist/index.js"></script>
6881
<script src="node_modules/@azure/arm-eventhub-profile-2020-09-01-hybrid/dist/arm-eventhub-profile-2020-09-01-hybrid.js"></script>
6982
<script type="text/javascript">
7083
const subscriptionId = "<Subscription_Id>";
71-
const authManager = new msAuth.AuthManager({
84+
// Create credentials using the `@azure/identity` package.
85+
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
86+
const credential = new InteractiveBrowserCredential(
87+
{
7288
clientId: "<client id for your Azure AD app>",
73-
tenant: "<optional tenant for your organization>"
89+
tenantId: "<optional tenant for your organization>"
7490
});
75-
authManager.finalizeLogin().then((res) => {
76-
if (!res.isLoggedIn) {
77-
// may cause redirects
78-
authManager.login();
79-
}
80-
const client = new Azure.ArmEventhubProfile20200901Hybrid.EventHubManagementClient(res.creds, subscriptionId);
81-
client.clusters.listAvailableClusterRegion().then((result) => {
82-
console.log("The result is:");
83-
console.log(result);
84-
}).catch((err) => {
85-
console.log("An error occurred:");
86-
console.error(err);
87-
});
91+
const client = new Azure.ArmEventhubProfile20200901Hybrid.EventHubManagementClient(creds, subscriptionId);
92+
client.clusters.listAvailableClusterRegion().then((result) => {
93+
console.log("The result is:");
94+
console.log(result);
95+
}).catch((err) => {
96+
console.log("An error occurred:");
97+
console.error(err);
8898
});
8999
</script>
90100
</head>

0 commit comments

Comments
 (0)