|
1 | | -## Azure PeeringManagementClient SDK for JavaScript |
| 1 | +# Azure PeeringManagement client library for JavaScript |
2 | 2 |
|
3 | | -This package contains an isomorphic SDK for PeeringManagementClient. |
| 3 | +This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure PeeringManagement client. |
| 4 | + |
| 5 | +Peering Client |
| 6 | + |
| 7 | +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/peering/arm-peering) | |
| 8 | +[Package (NPM)](https://www.npmjs.com/package/@azure/arm-peering) | |
| 9 | +[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-peering) | |
| 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. |
| 18 | + |
| 19 | +### Prerequisites |
| 20 | + |
| 21 | +- An [Azure subscription][azure_sub]. |
| 22 | + |
| 23 | +### Install the `@azure/arm-peering` package |
9 | 24 |
|
10 | | -### How to Install |
| 25 | +Install the Azure PeeringManagement client library for JavaScript with `npm`: |
11 | 26 |
|
12 | 27 | ```bash |
13 | 28 | npm install @azure/arm-peering |
14 | 29 | ``` |
15 | 30 |
|
16 | | -### How to use |
| 31 | +### Create and authenticate a `PeeringManagementClient` |
17 | 32 |
|
18 | | -#### nodejs - Authentication, client creation and list legacyPeerings as an example written in TypeScript. |
| 33 | +To create a client object to access the Azure PeeringManagement API, you will need the `endpoint` of your Azure PeeringManagement resource and a `credential`. The Azure PeeringManagement client can use Azure Active Directory credentials to authenticate. |
| 34 | +You can find the endpoint for your Azure PeeringManagement resource in the [Azure Portal][azure_portal]. |
19 | 35 |
|
20 | | -##### Install @azure/ms-rest-nodeauth |
| 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 | + |
| 38 | +To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package: |
21 | 39 |
|
22 | | -- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`. |
23 | 40 | ```bash |
24 | | -npm install @azure/ms-rest-nodeauth@"^3.0.0" |
| 41 | +npm install @azure/identity |
25 | 42 | ``` |
26 | 43 |
|
27 | | -##### Sample code |
28 | | - |
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 { PeeringManagementClient, PeeringManagementModels, PeeringManagementMappers } from "@azure/arm-peering"; |
34 | | -const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; |
35 | | - |
36 | | -msRestNodeAuth.interactiveLogin().then((creds) => { |
37 | | - const client = new PeeringManagementClient(creds, subscriptionId); |
38 | | - const peeringLocation = "testpeeringLocation"; |
39 | | - const kind = "Direct"; |
40 | | - client.legacyPeerings.list(peeringLocation, kind).then((result) => { |
41 | | - console.log("The result is:"); |
42 | | - console.log(result); |
43 | | - }); |
44 | | -}).catch((err) => { |
45 | | - console.error(err); |
46 | | -}); |
| 44 | +You will also need to **register a new AAD application and grant access to Azure PeeringManagement** 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`. |
| 46 | + |
| 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). |
| 48 | + |
| 49 | +```javascript |
| 50 | +const { PeeringManagementClient } = require("@azure/arm-peering"); |
| 51 | +const { DefaultAzureCredential } = require("@azure/identity"); |
| 52 | +const subscriptionId = "00000000-0000-0000-0000-000000000000"; |
| 53 | +const client = new PeeringManagementClient(new DefaultAzureCredential(), subscriptionId); |
47 | 54 | ``` |
48 | 55 |
|
49 | | -#### browser - Authentication, client creation and list legacyPeerings as an example written in JavaScript. |
50 | 56 |
|
51 | | -##### Install @azure/ms-rest-browserauth |
| 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). |
52 | 59 |
|
53 | | -```bash |
54 | | -npm install @azure/ms-rest-browserauth |
55 | | -``` |
| 60 | +## Key concepts |
56 | 61 |
|
57 | | -##### Sample code |
58 | | - |
59 | | -See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. |
60 | | - |
61 | | -- index.html |
62 | | -```html |
63 | | -<!DOCTYPE html> |
64 | | -<html lang="en"> |
65 | | - <head> |
66 | | - <title>@azure/arm-peering sample</title> |
67 | | - <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> |
68 | | - <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> |
69 | | - <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script> |
70 | | - <script src="node_modules/@azure/arm-peering/dist/arm-peering.js"></script> |
71 | | - <script type="text/javascript"> |
72 | | - const subscriptionId = "<Subscription_Id>"; |
73 | | - const authManager = new msAuth.AuthManager({ |
74 | | - clientId: "<client id for your Azure AD app>", |
75 | | - tenant: "<optional tenant for your organization>" |
76 | | - }); |
77 | | - authManager.finalizeLogin().then((res) => { |
78 | | - if (!res.isLoggedIn) { |
79 | | - // may cause redirects |
80 | | - authManager.login(); |
81 | | - } |
82 | | - const client = new Azure.ArmPeering.PeeringManagementClient(res.creds, subscriptionId); |
83 | | - const peeringLocation = "testpeeringLocation"; |
84 | | - const kind = "Direct"; |
85 | | - client.legacyPeerings.list(peeringLocation, kind).then((result) => { |
86 | | - console.log("The result is:"); |
87 | | - console.log(result); |
88 | | - }).catch((err) => { |
89 | | - console.log("An error occurred:"); |
90 | | - console.error(err); |
91 | | - }); |
92 | | - }); |
93 | | - </script> |
94 | | - </head> |
95 | | - <body></body> |
96 | | -</html> |
| 62 | +### PeeringManagementClient |
| 63 | + |
| 64 | +`PeeringManagementClient` is the primary interface for developers using the Azure PeeringManagement client library. Explore the methods on this client object to understand the different features of the Azure PeeringManagement 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"); |
97 | 75 | ``` |
98 | 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 | + |
99 | 87 | ## Related projects |
100 | 88 |
|
101 | | -- [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) |
102 | 90 |
|
103 | 91 |  |
| 92 | + |
| 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