|
1 | 1 | ## Azure RedisManagementClient SDK for JavaScript
|
2 | 2 |
|
3 |
| -This package contains an isomorphic SDK for RedisManagementClient. |
| 3 | +This package contains an isomorphic SDK (runs both in node.js and in browsers) for RedisManagementClient. |
4 | 4 |
|
5 | 5 | ### Currently supported environments
|
6 | 6 |
|
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. |
9 | 9 |
|
10 |
| -### How to Install |
| 10 | +### Prerequisites |
11 | 11 |
|
| 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-rediscache` 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: |
12 | 21 | ```bash
|
13 |
| -npm install @azure/arm-rediscache |
| 22 | +npm install --save @azure/arm-rediscache @azure/identity |
14 | 23 | ```
|
| 24 | +> **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. |
| 25 | +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. |
15 | 26 |
|
16 | 27 | ### How to use
|
17 | 28 |
|
18 |
| -#### nodejs - Authentication, client creation and list operations as an example written in TypeScript. |
| 29 | +- If you are writing a client side browser application, |
| 30 | + - 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. |
| 31 | + - 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. |
| 32 | +- If you are writing a server side application, |
| 33 | + - [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples) |
| 34 | + - Complete the set up steps required by the credential if any. |
| 35 | + - Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below. |
19 | 36 |
|
20 |
| -##### Install @azure/ms-rest-nodeauth |
21 |
| - |
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 |
| -``` |
| 37 | +In the below samples, we pass the credential and the Azure subscription id to instantiate the client. |
| 38 | +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. |
| 39 | +#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript. |
26 | 40 |
|
27 | 41 | ##### Sample code
|
28 | 42 |
|
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 { RedisManagementClient, RedisManagementModels, RedisManagementMappers } from "@azure/arm-rediscache"; |
| 43 | +```javascript |
| 44 | +const { DefaultAzureCredential } = require("@azure/identity"); |
| 45 | +const { RedisManagementClient } = require("@azure/arm-rediscache"); |
34 | 46 | const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
|
35 | 47 |
|
36 |
| -msRestNodeAuth.interactiveLogin().then((creds) => { |
37 |
| - const client = new RedisManagementClient(creds, subscriptionId); |
38 |
| - client.operations.list().then((result) => { |
39 |
| - console.log("The result is:"); |
40 |
| - console.log(result); |
41 |
| - }); |
| 48 | +// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples |
| 49 | +// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead. |
| 50 | +const creds = new DefaultAzureCredential(); |
| 51 | +const client = new RedisManagementClient(creds, subscriptionId); |
| 52 | +client.operations.list().then((result) => { |
| 53 | + console.log("The result is:"); |
| 54 | + console.log(result); |
42 | 55 | }).catch((err) => {
|
| 56 | + console.log("An error occurred:"); |
43 | 57 | console.error(err);
|
44 | 58 | });
|
45 | 59 | ```
|
46 | 60 |
|
47 |
| -#### browser - Authentication, client creation and list operations as an example written in JavaScript. |
| 61 | +#### browser - Authentication, client creation, and list operations as an example written in JavaScript. |
48 | 62 |
|
49 |
| -##### Install @azure/ms-rest-browserauth |
50 |
| - |
51 |
| -```bash |
52 |
| -npm install @azure/ms-rest-browserauth |
53 |
| -``` |
| 63 | +In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser. |
| 64 | + - 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. |
| 65 | + - Note down the client Id from the previous step and use it in the browser sample below. |
54 | 66 |
|
55 | 67 | ##### Sample code
|
56 | 68 |
|
57 |
| -See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. |
58 |
| - |
59 | 69 | - index.html
|
| 70 | + |
60 | 71 | ```html
|
61 | 72 | <!DOCTYPE html>
|
62 | 73 | <html lang="en">
|
63 | 74 | <head>
|
64 | 75 | <title>@azure/arm-rediscache sample</title>
|
65 |
| - <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> |
66 | 76 | <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> |
| 77 | + <script src="node_modules/@azure/identity/dist/index.js"></script> |
68 | 78 | <script src="node_modules/@azure/arm-rediscache/dist/arm-rediscache.js"></script>
|
69 | 79 | <script type="text/javascript">
|
70 | 80 | const subscriptionId = "<Subscription_Id>";
|
71 |
| - const authManager = new msAuth.AuthManager({ |
| 81 | + // Create credentials using the `@azure/identity` package. |
| 82 | + // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead. |
| 83 | + const credential = new InteractiveBrowserCredential( |
| 84 | + { |
72 | 85 | clientId: "<client id for your Azure AD app>",
|
73 | 86 | tenant: "<optional tenant for your organization>"
|
74 | 87 | });
|
75 |
| - authManager.finalizeLogin().then((res) => { |
76 |
| - if (!res.isLoggedIn) { |
77 |
| - // may cause redirects |
78 |
| - authManager.login(); |
79 |
| - } |
80 |
| - const client = new Azure.ArmRediscache.RedisManagementClient(res.creds, subscriptionId); |
81 |
| - client.operations.list().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 |
| - }); |
| 88 | + const client = new Azure.ArmRediscache.RedisManagementClient(creds, subscriptionId); |
| 89 | + client.operations.list().then((result) => { |
| 90 | + console.log("The result is:"); |
| 91 | + console.log(result); |
| 92 | + }).catch((err) => { |
| 93 | + console.log("An error occurred:"); |
| 94 | + console.error(err); |
88 | 95 | });
|
89 | 96 | </script>
|
90 | 97 | </head>
|
|
0 commit comments