Skip to content

Commit 2e05c13

Browse files
author
SDKAuto
committed
CodeGen from PR 14736 in Azure/azure-rest-api-specs
Merge 2290fefedc09ebcef566a51b9bfc99e3ece13257 into f7535f8211b7fe9a8d5e5ebdc09830677b55285c
1 parent 556da80 commit 2e05c13

17 files changed

+1020
-986
lines changed

‎sdk/managedapplications/arm-managedapplications/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/managedapplications/arm-managedapplications/README.md

Lines changed: 56 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,97 @@
1-
## Azure ManagedApplicationClient SDK for JavaScript
1+
## Azure ApplicationClient SDK for JavaScript
22

3-
This package contains an isomorphic SDK for ManagedApplicationClient.
3+
This package contains an isomorphic SDK (runs both in node.js and in browsers) for ApplicationClient.
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-managedapplications` 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-managedapplications
22+
npm install --save @azure/arm-managedapplications @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 listOperations 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-
```bash
23-
npm install @azure/ms-rest-nodeauth
24-
```
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 listOperations as an example written in JavaScript.
2540

2641
##### Sample code
2742

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 { ManagedApplicationClient, ManagedApplicationModels, ManagedApplicationMappers } from "@azure/arm-managedapplications";
43+
```javascript
44+
const { DefaultAzureCredential } = require("@azure/identity");
45+
const { ApplicationClient } = require("@azure/arm-managedapplications");
3346
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
3447

35-
msRestNodeAuth.interactiveLogin().then((creds) => {
36-
const client = new ManagedApplicationClient(creds, subscriptionId);
37-
client.listOperations().then((result) => {
38-
console.log("The result is:");
39-
console.log(result);
40-
});
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 ApplicationClient(creds, subscriptionId);
52+
client.listOperations().then((result) => {
53+
console.log("The result is:");
54+
console.log(result);
4155
}).catch((err) => {
56+
console.log("An error occurred:");
4257
console.error(err);
4358
});
4459
```
4560

46-
#### browser - Authentication, client creation and listOperations as an example written in JavaScript.
61+
#### browser - Authentication, client creation, and listOperations as an example written in JavaScript.
4762

48-
##### Install @azure/ms-rest-browserauth
49-
50-
```bash
51-
npm install @azure/ms-rest-browserauth
52-
```
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.
5366

5467
##### Sample code
5568

56-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
57-
5869
- index.html
70+
5971
```html
6072
<!DOCTYPE html>
6173
<html lang="en">
6274
<head>
6375
<title>@azure/arm-managedapplications sample</title>
64-
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
6576
<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>
77+
<script src="node_modules/@azure/identity/dist/index.js"></script>
6778
<script src="node_modules/@azure/arm-managedapplications/dist/arm-managedapplications.js"></script>
6879
<script type="text/javascript">
6980
const subscriptionId = "<Subscription_Id>";
70-
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+
{
7185
clientId: "<client id for your Azure AD app>",
7286
tenant: "<optional tenant for your organization>"
7387
});
74-
authManager.finalizeLogin().then((res) => {
75-
if (!res.isLoggedIn) {
76-
// may cause redirects
77-
authManager.login();
78-
}
79-
const client = new Azure.ArmManagedapplications.ManagedApplicationClient(res.creds, subscriptionId);
80-
client.listOperations().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-
});
88+
const client = new Azure.ArmManagedapplications.ApplicationClient(creds, subscriptionId);
89+
client.listOperations().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);
8795
});
8896
</script>
8997
</head>
@@ -95,4 +103,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to
95103

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

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

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
{
22
"name": "@azure/arm-managedapplications",
33
"author": "Microsoft Corporation",
4-
"description": "ManagedApplicationClient Library with typescript type definitions for node.js and browser.",
4+
"description": "ApplicationClient Library with typescript type definitions for node.js and browser.",
55
"version": "1.0.2",
66
"dependencies": {
7-
"@azure/ms-rest-azure-js": "^1.3.2",
8-
"@azure/ms-rest-js": "^1.8.1",
9-
"tslib": "^1.9.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",
10+
"tslib": "^1.10.0"
1011
},
1112
"keywords": [
1213
"node",
@@ -17,16 +18,16 @@
1718
],
1819
"license": "MIT",
1920
"main": "./dist/arm-managedapplications.js",
20-
"module": "./esm/managedApplicationClient.js",
21-
"types": "./esm/managedApplicationClient.d.ts",
21+
"module": "./esm/applicationClient.js",
22+
"types": "./esm/applicationClient.d.ts",
2223
"devDependencies": {
23-
"typescript": "^3.1.1",
24-
"rollup": "^0.66.2",
25-
"rollup-plugin-node-resolve": "^3.4.0",
24+
"typescript": "^3.6.0",
25+
"rollup": "^1.18.0",
26+
"rollup-plugin-node-resolve": "^5.2.0",
2627
"rollup-plugin-sourcemaps": "^0.4.2",
27-
"uglify-js": "^3.4.9"
28+
"uglify-js": "^3.6.0"
2829
},
29-
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/managedapplications/arm-managedapplications",
30+
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/managedapplications/arm-managedapplications",
3031
"repository": {
3132
"type": "git",
3233
"url": "https://github.com/Azure/azure-sdk-for-js.git"

‎sdk/managedapplications/arm-managedapplications/rollup.config.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import sourcemaps from "rollup-plugin-sourcemaps";
66
* @type {rollup.RollupFileOptions}
77
*/
88
const config = {
9-
input: "./esm/managedApplicationClient.js",
9+
input: "./esm/applicationClient.js",
1010
external: [
1111
"@azure/ms-rest-js",
1212
"@azure/ms-rest-azure-js"
@@ -21,15 +21,15 @@ 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.
2929
*/`
3030
},
3131
plugins: [
32-
nodeResolve({ module: true }),
32+
nodeResolve({ mainFields: ['module', 'main'] }),
3333
sourcemaps()
3434
]
3535
};

‎sdk/managedapplications/arm-managedapplications/src/managedApplicationClient.ts renamed to ‎sdk/managedapplications/arm-managedapplications/src/applicationClient.ts

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
11
/*
2-
* Copyright (c) Microsoft Corporation. All rights reserved.
3-
* Licensed under the MIT License. See License.txt in the project root for
4-
* license information.
2+
* Copyright (c) Microsoft Corporation.
3+
* Licensed under the MIT License.
54
*
65
* Code generated by Microsoft (R) AutoRest Code Generator.
76
* Changes may cause incorrect behavior and will be lost if the code is
87
* regenerated.
98
*/
109

1110
import * as msRest from "@azure/ms-rest-js";
11+
import { TokenCredential } from "@azure/core-auth";
1212
import * as Models from "./models";
1313
import * as Mappers from "./models/mappers";
1414
import * as Parameters from "./models/parameters";
1515
import * as operations from "./operations";
16-
import { ManagedApplicationClientContext } from "./managedApplicationClientContext";
16+
import { ApplicationClientContext } from "./applicationClientContext";
1717

1818

19-
class ManagedApplicationClient extends ManagedApplicationClientContext {
19+
class ApplicationClient extends ApplicationClientContext {
2020
// Operation groups
21-
appliances: operations.Appliances;
22-
applianceDefinitions: operations.ApplianceDefinitions;
21+
applications: operations.Applications;
22+
applicationDefinitions: operations.ApplicationDefinitions;
2323

2424
/**
25-
* Initializes a new instance of the ManagedApplicationClient class.
26-
* @param credentials Credentials needed for the client to connect to Azure.
25+
* Initializes a new instance of the ApplicationClient class.
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.
2732
* @param subscriptionId The ID of the target subscription.
2833
* @param [options] The parameter options
2934
*/
30-
constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.ManagedApplicationClientOptions) {
35+
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ApplicationClientOptions) {
3136
super(credentials, subscriptionId, options);
32-
this.appliances = new operations.Appliances(this);
33-
this.applianceDefinitions = new operations.ApplianceDefinitions(this);
37+
this.applications = new operations.Applications(this);
38+
this.applicationDefinitions = new operations.ApplicationDefinitions(this);
3439
}
3540

3641
/**
@@ -115,6 +120,9 @@ const listOperationsNextOperationSpec: msRest.OperationSpec = {
115120
urlParameters: [
116121
Parameters.nextPageLink
117122
],
123+
queryParameters: [
124+
Parameters.apiVersion
125+
],
118126
headerParameters: [
119127
Parameters.acceptLanguage
120128
],
@@ -130,9 +138,9 @@ const listOperationsNextOperationSpec: msRest.OperationSpec = {
130138
};
131139

132140
export {
133-
ManagedApplicationClient,
134-
ManagedApplicationClientContext,
135-
Models as ManagedApplicationModels,
136-
Mappers as ManagedApplicationMappers
141+
ApplicationClient,
142+
ApplicationClientContext,
143+
Models as ApplicationModels,
144+
Mappers as ApplicationMappers
137145
};
138146
export * from "./operations";

‎sdk/managedapplications/arm-managedapplications/src/managedApplicationClientContext.ts renamed to ‎sdk/managedapplications/arm-managedapplications/src/applicationClientContext.ts

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +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
4-
* license information.
2+
* Copyright (c) Microsoft Corporation.
3+
* Licensed under the MIT License.
54
*
65
* Code generated by Microsoft (R) AutoRest Code Generator.
76
* Changes may cause incorrect behavior and will be lost if the code is
@@ -11,22 +10,28 @@
1110
import * as Models from "./models";
1211
import * as msRest from "@azure/ms-rest-js";
1312
import * as msRestAzure from "@azure/ms-rest-azure-js";
13+
import { TokenCredential } from "@azure/core-auth";
1414

1515
const packageName = "@azure/arm-managedapplications";
1616
const packageVersion = "1.0.2";
1717

18-
export class ManagedApplicationClientContext extends msRestAzure.AzureServiceClient {
19-
credentials: msRest.ServiceClientCredentials;
18+
export class ApplicationClientContext extends msRestAzure.AzureServiceClient {
19+
credentials: msRest.ServiceClientCredentials | TokenCredential;
2020
subscriptionId: string;
2121
apiVersion?: string;
2222

2323
/**
24-
* Initializes a new instance of the ManagedApplicationClient class.
25-
* @param credentials Credentials needed for the client to connect to Azure.
24+
* Initializes a new instance of the ApplicationClient class.
25+
* @param credentials Credentials needed for the client to connect to Azure. Credentials
26+
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
27+
* more information about these credentials, see
28+
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
29+
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
30+
* @azure/ms-rest-browserauth are also supported.
2631
* @param subscriptionId The ID of the target subscription.
2732
* @param [options] The parameter options
2833
*/
29-
constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.ManagedApplicationClientOptions) {
34+
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ApplicationClientOptions) {
3035
if (credentials == undefined) {
3136
throw new Error('\'credentials\' cannot be null.');
3237
}
@@ -37,25 +42,25 @@ export class ManagedApplicationClientContext extends msRestAzure.AzureServiceCli
3742
if (!options) {
3843
options = {};
3944
}
40-
if(!options.userAgent) {
45+
if (!options.userAgent) {
4146
const defaultUserAgent = msRestAzure.getDefaultUserAgentValue();
4247
options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
4348
}
4449

4550
super(credentials, options);
4651

47-
this.apiVersion = '2016-09-01-preview';
52+
this.apiVersion = '2018-06-01';
4853
this.acceptLanguage = 'en-US';
4954
this.longRunningOperationRetryTimeout = 30;
5055
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
5156
this.requestContentType = "application/json; charset=utf-8";
5257
this.credentials = credentials;
5358
this.subscriptionId = subscriptionId;
5459

55-
if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
60+
if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
5661
this.acceptLanguage = options.acceptLanguage;
5762
}
58-
if(options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
63+
if (options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
5964
this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout;
6065
}
6166
}

0 commit comments

Comments
 (0)