|
1 | | -## Azure DevSpacesManagementClient SDK for JavaScript |
| 1 | +# Azure DevSpacesManagement client library for JavaScript |
2 | 2 |
|
3 | | -This package contains an isomorphic SDK (runs both in Node.js and in browsers) for DevSpacesManagementClient. |
| 3 | +This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure DevSpacesManagement client. |
| 4 | + |
| 5 | +Dev Spaces Client |
| 6 | + |
| 7 | +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devspaces/arm-devspaces) | |
| 8 | +[Package (NPM)](https://www.npmjs.com/package/@azure/arm-devspaces) | |
| 9 | +[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-devspaces) | |
| 10 | +[Samples](https://github.com/Azure-Samples/azure-samples-js-management) |
| 11 | + |
| 12 | +## Getting started |
4 | 13 |
|
5 | 14 | ### Currently supported environments |
6 | 15 |
|
7 | 16 | - [LTS versions of Node.js](https://nodejs.org/about/releases/) |
8 | | -- Latest versions of Safari, Chrome, Edge, and Firefox. |
| 17 | +- Latest versions of Safari, Chrome, Edge and Firefox. |
9 | 18 |
|
10 | 19 | ### Prerequisites |
11 | 20 |
|
12 | | -You must have an [Azure subscription](https://azure.microsoft.com/free/). |
| 21 | +- An [Azure subscription][azure_sub]. |
13 | 22 |
|
14 | | -### How to install |
| 23 | +### Install the `@azure/arm-devspaces` package |
15 | 24 |
|
16 | | -To use this SDK in your project, you will need to install two packages. |
17 | | -- `@azure/arm-devspaces` that contains the client. |
18 | | -- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory. |
| 25 | +Install the Azure DevSpacesManagement client library for JavaScript with `npm`: |
19 | 26 |
|
20 | | -Install both packages using the below command: |
21 | 27 | ```bash |
22 | | -npm install --save @azure/arm-devspaces @azure/identity |
| 28 | +npm install @azure/arm-devspaces |
23 | 29 | ``` |
24 | 30 |
|
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. |
| 31 | +### Create and authenticate a `DevSpacesManagementClient` |
27 | 32 |
|
28 | | -### How to use |
| 33 | +To create a client object to access the Azure DevSpacesManagement API, you will need the `endpoint` of your Azure DevSpacesManagement resource and a `credential`. The Azure DevSpacesManagement client can use Azure Active Directory credentials to authenticate. |
| 34 | +You can find the endpoint for your Azure DevSpacesManagement resource in the [Azure Portal][azure_portal]. |
29 | 35 |
|
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. |
| 36 | +You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token). |
37 | 37 |
|
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. |
| 38 | +To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package: |
| 39 | + |
| 40 | +```bash |
| 41 | +npm install @azure/identity |
| 42 | +``` |
40 | 43 |
|
41 | | -#### nodejs - Authentication, client creation, and get controllers as an example written in JavaScript. |
| 44 | +You will also need to **register a new AAD application and grant access to Azure DevSpacesManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions). |
| 45 | +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`. |
42 | 46 |
|
43 | | -##### Sample code |
| 47 | +For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal). |
44 | 48 |
|
45 | 49 | ```javascript |
46 | | -const { DefaultAzureCredential } = require("@azure/identity"); |
47 | 50 | const { DevSpacesManagementClient } = require("@azure/arm-devspaces"); |
48 | | -const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; |
49 | | - |
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 DevSpacesManagementClient(creds, subscriptionId); |
54 | | -const resourceGroupName = "testresourceGroupName"; |
55 | | -const name = "testname"; |
56 | | -client.controllers.get(resourceGroupName, name).then((result) => { |
57 | | - console.log("The result is:"); |
58 | | - console.log(result); |
59 | | -}).catch((err) => { |
60 | | - console.log("An error occurred:"); |
61 | | - console.error(err); |
62 | | -}); |
| 51 | +const { DefaultAzureCredential } = require("@azure/identity"); |
| 52 | +const subscriptionId = "00000000-0000-0000-0000-000000000000"; |
| 53 | +const client = new DevSpacesManagementClient(new DefaultAzureCredential(), subscriptionId); |
63 | 54 | ``` |
64 | 55 |
|
65 | | -#### browser - Authentication, client creation, and get controllers as an example written in JavaScript. |
66 | | - |
67 | | -In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser. |
68 | | - - 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. |
69 | | - - Note down the client Id from the previous step and use it in the browser sample below. |
70 | | - |
71 | | -##### Sample code |
72 | | - |
73 | | -- index.html |
74 | | - |
75 | | -```html |
76 | | -<!DOCTYPE html> |
77 | | -<html lang="en"> |
78 | | - <head> |
79 | | - <title>@azure/arm-devspaces sample</title> |
80 | | - <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> |
81 | | - <script src="node_modules/@azure/identity/dist/index.js"></script> |
82 | | - <script src="node_modules/@azure/arm-devspaces/dist/arm-devspaces.js"></script> |
83 | | - <script type="text/javascript"> |
84 | | - const subscriptionId = "<Subscription_Id>"; |
85 | | - // Create credentials using the `@azure/identity` package. |
86 | | - // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead. |
87 | | - const credential = new InteractiveBrowserCredential( |
88 | | - { |
89 | | - clientId: "<client id for your Azure AD app>", |
90 | | - tenantId: "<optional tenant for your organization>" |
91 | | - }); |
92 | | - const client = new Azure.ArmDevspaces.DevSpacesManagementClient(creds, subscriptionId); |
93 | | - const resourceGroupName = "testresourceGroupName"; |
94 | | - const name = "testname"; |
95 | | - client.controllers.get(resourceGroupName, name).then((result) => { |
96 | | - console.log("The result is:"); |
97 | | - console.log(result); |
98 | | - }).catch((err) => { |
99 | | - console.log("An error occurred:"); |
100 | | - console.error(err); |
101 | | - }); |
102 | | - </script> |
103 | | - </head> |
104 | | - <body></body> |
105 | | -</html> |
| 56 | + |
| 57 | +### JavaScript Bundle |
| 58 | +To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling). |
| 59 | + |
| 60 | +## Key concepts |
| 61 | + |
| 62 | +### DevSpacesManagementClient |
| 63 | + |
| 64 | +`DevSpacesManagementClient` is the primary interface for developers using the Azure DevSpacesManagement client library. Explore the methods on this client object to understand the different features of the Azure DevSpacesManagement service that you can access. |
| 65 | + |
| 66 | +## Troubleshooting |
| 67 | + |
| 68 | +### Logging |
| 69 | + |
| 70 | +Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: |
| 71 | + |
| 72 | +```javascript |
| 73 | +const { setLogLevel } = require("@azure/logger"); |
| 74 | +setLogLevel("info"); |
106 | 75 | ``` |
107 | 76 |
|
| 77 | +For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger). |
| 78 | + |
| 79 | +## Next steps |
| 80 | + |
| 81 | +Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library. |
| 82 | + |
| 83 | +## Contributing |
| 84 | + |
| 85 | +If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code. |
| 86 | + |
108 | 87 | ## Related projects |
109 | 88 |
|
110 | | -- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) |
| 89 | +- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js) |
| 90 | + |
| 91 | + |
111 | 92 |
|
112 | | - |
| 93 | +[azure_cli]: https://docs.microsoft.com/cli/azure |
| 94 | +[azure_sub]: https://azure.microsoft.com/free/ |
| 95 | +[azure_sub]: https://azure.microsoft.com/free/ |
| 96 | +[azure_portal]: https://portal.azure.com |
| 97 | +[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity |
| 98 | +[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential |
0 commit comments