Skip to content

Commit 37f99f5

Browse files
author
SDKAuto
committed
CodeGen from PR 14656 in Azure/azure-rest-api-specs
Merge 1620e2766ecb1b58bec091aa5fa6ecbbd52a58e7 into 6a4ecaba56b6bc6bda4986730f1ff191d6420640
1 parent 60d4d5b commit 37f99f5

39 files changed

+3293
-582
lines changed

sdk/peering/arm-peering/LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2019 Microsoft
3+
Copyright (c) 2021 Microsoft
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

sdk/peering/arm-peering/README.md

Lines changed: 56 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,99 @@
11
## Azure PeeringManagementClient SDK for JavaScript
22

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 PeeringManagementClient.
44

55
### Currently supported environments
66

7-
- Node.js version 6.x.x or higher
7+
- Node.js version 8.x.x or higher
88
- Browser JavaScript
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-peering` 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-peering
22+
npm install --save @azure/arm-peering @azure/identity
1423
```
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.
1526

1627
### How to use
1728

18-
#### nodejs - Authentication, client creation and list legacyPeerings 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.
1936

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 cdnPeeringPrefixes as an example written in JavaScript.
2640

2741
##### Sample code
2842

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";
43+
```javascript
44+
const { DefaultAzureCredential } = require("@azure/identity");
45+
const { PeeringManagementClient } = require("@azure/arm-peering");
3446
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
3547

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-
});
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 PeeringManagementClient(creds, subscriptionId);
52+
const peeringLocation = "testpeeringLocation";
53+
client.cdnPeeringPrefixes.list(peeringLocation).then((result) => {
54+
console.log("The result is:");
55+
console.log(result);
4456
}).catch((err) => {
57+
console.log("An error occurred:");
4558
console.error(err);
4659
});
4760
```
4861

49-
#### browser - Authentication, client creation and list legacyPeerings as an example written in JavaScript.
62+
#### browser - Authentication, client creation, and list cdnPeeringPrefixes as an example written in JavaScript.
5063

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

5768
##### Sample code
5869

59-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
60-
6170
- index.html
71+
6272
```html
6373
<!DOCTYPE html>
6474
<html lang="en">
6575
<head>
6676
<title>@azure/arm-peering sample</title>
67-
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
6877
<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>
78+
<script src="node_modules/@azure/identity/dist/index.js"></script>
7079
<script src="node_modules/@azure/arm-peering/dist/arm-peering.js"></script>
7180
<script type="text/javascript">
7281
const subscriptionId = "<Subscription_Id>";
73-
const authManager = new msAuth.AuthManager({
82+
// Create credentials using the `@azure/identity` package.
83+
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
84+
const credential = new InteractiveBrowserCredential(
85+
{
7486
clientId: "<client id for your Azure AD app>",
7587
tenant: "<optional tenant for your organization>"
7688
});
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-
});
89+
const client = new Azure.ArmPeering.PeeringManagementClient(creds, subscriptionId);
90+
const peeringLocation = "testpeeringLocation";
91+
client.cdnPeeringPrefixes.list(peeringLocation).then((result) => {
92+
console.log("The result is:");
93+
console.log(result);
94+
}).catch((err) => {
95+
console.log("An error occurred:");
96+
console.error(err);
9297
});
9398
</script>
9499
</head>
@@ -100,4 +105,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to
100105

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

103-
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fpeering%2Farm-peering%2FREADME.png)
108+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/peering/arm-peering/README.png)

sdk/peering/arm-peering/package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
"description": "PeeringManagementClient Library with typescript type definitions for node.js and browser.",
55
"version": "1.0.0",
66
"dependencies": {
7-
"@azure/ms-rest-azure-js": "^2.0.1",
8-
"@azure/ms-rest-js": "^2.0.4",
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/peeringManagementClient.js",
2122
"types": "./esm/peeringManagementClient.d.ts",
2223
"devDependencies": {
23-
"typescript": "^3.5.3",
24+
"typescript": "^3.6.0",
2425
"rollup": "^1.18.0",
2526
"rollup-plugin-node-resolve": "^5.2.0",
2627
"rollup-plugin-sourcemaps": "^0.4.2",

sdk/peering/arm-peering/rollup.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ const config = {
2121
"@azure/ms-rest-azure-js": "msRestAzure"
2222
},
2323
banner: `/*
24-
* Copyright (c) Microsoft Corporation. All rights reserved.
25-
* Licensed under the MIT License. See License.txt in the project root for license information.
24+
* Copyright (c) Microsoft Corporation.
25+
* Licensed under the MIT License.
2626
*
2727
* Code generated by Microsoft (R) AutoRest Code Generator.
2828
* Changes may cause incorrect behavior and will be lost if the code is regenerated.

sdk/peering/arm-peering/src/models/peeringServicePrefixesMappers.ts renamed to sdk/peering/arm-peering/src/models/cdnPeeringPrefixesMappers.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
2-
* Copyright (c) Microsoft Corporation. All rights reserved.
3-
* Licensed under the MIT License. See License.txt in the project root for license information.
2+
* Copyright (c) Microsoft Corporation.
3+
* Licensed under the MIT License.
44
*
55
* Code generated by Microsoft (R) AutoRest Code Generator.
66
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
@@ -9,9 +9,12 @@
99
export {
1010
BaseResource,
1111
BgpSession,
12-
ContactInfo,
12+
CdnPeeringPrefix,
13+
CdnPeeringPrefixListResult,
14+
ContactDetail,
1315
DirectConnection,
1416
DirectPeeringFacility,
17+
ErrorDetail,
1518
ErrorResponse,
1619
ExchangeConnection,
1720
ExchangePeeringFacility,
@@ -23,10 +26,15 @@ export {
2326
PeeringLocationPropertiesExchange,
2427
PeeringPropertiesDirect,
2528
PeeringPropertiesExchange,
29+
PeeringRegisteredAsn,
30+
PeeringRegisteredPrefix,
2631
PeeringService,
32+
PeeringServiceCountry,
2733
PeeringServiceLocation,
2834
PeeringServicePrefix,
35+
PeeringServicePrefixEvent,
2936
PeeringServiceProvider,
37+
PeeringServiceSku,
3038
PeeringSku,
3139
Resource,
3240
SubResource

0 commit comments

Comments
 (0)