Skip to content

Commit

Permalink
CodeGen from PR 14365 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge dd5c5b5398348ab340dcda6ffdacf9646712f3f5 into 10c93ad91d3f44f62f2568a5b480c538a7c15daf
  • Loading branch information
SDKAuto committed Jun 7, 2021
1 parent 8d9983e commit 4d5d088
Show file tree
Hide file tree
Showing 13 changed files with 1,201 additions and 1,105 deletions.
96 changes: 52 additions & 44 deletions sdk/netapp/arm-netapp/README.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,97 @@
## Azure AzureNetAppFilesManagementClient SDK for JavaScript

This package contains an isomorphic SDK for AzureNetAppFilesManagementClient.
This package contains an isomorphic SDK (runs both in node.js and in browsers) for AzureNetAppFilesManagementClient.

### Currently supported environments

- Node.js version 6.x.x or higher
- Node.js version 8.x.x or higher
- Browser JavaScript

### How to Install
### Prerequisites

You must have an [Azure subscription](https://azure.microsoft.com/free/).

### How to install

To use this SDK in your project, you will need to install two packages.
- `@azure/arm-netapp` that contains the client.
- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.

Install both packages using the below command:
```bash
npm install @azure/arm-netapp
npm install --save @azure/arm-netapp @azure/identity
```
> **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.
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.

### How to use

#### nodejs - client creation and list operations as an example written in TypeScript.
- If you are writing a client side browser application,
- 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.
- 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.
- If you are writing a server side application,
- [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
- Complete the set up steps required by the credential if any.
- Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.

##### Install @azure/ms-rest-nodeauth

- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
```bash
npm install @azure/ms-rest-nodeauth@"^3.0.0"
```
In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
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.
#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript.

##### Sample code

While the below sample uses the interactive login, other authentication options can be found in the [README.md file of @azure/ms-rest-nodeauth](https://www.npmjs.com/package/@azure/ms-rest-nodeauth) package
```typescript
const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
```javascript
const { DefaultAzureCredential } = require("@azure/identity");
const { AzureNetAppFilesManagementClient } = require("@azure/arm-netapp");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new AzureNetAppFilesManagementClient(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new AzureNetAppFilesManagementClient(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
```

#### browser - Authentication, client creation and list operations as an example written in JavaScript.
#### browser - Authentication, client creation, and list operations as an example written in JavaScript.

##### Install @azure/ms-rest-browserauth

```bash
npm install @azure/ms-rest-browserauth
```
In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
- 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.
- Note down the client Id from the previous step and use it in the browser sample below.

##### Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

- index.html

```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-netapp sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/identity/dist/index.js"></script>
<script src="node_modules/@azure/arm-netapp/dist/arm-netapp.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
// Create credentials using the `@azure/identity` package.
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmNetapp.AzureNetAppFilesManagementClient(res.creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
const client = new Azure.ArmNetapp.AzureNetAppFilesManagementClient(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
</script>
</head>
Expand Down
7 changes: 4 additions & 3 deletions sdk/netapp/arm-netapp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
"description": "AzureNetAppFilesManagementClient Library with typescript type definitions for node.js and browser.",
"version": "14.0.0",
"dependencies": {
"@azure/ms-rest-azure-js": "^2.0.1",
"@azure/ms-rest-js": "^2.0.4",
"@azure/ms-rest-azure-js": "^2.1.0",
"@azure/ms-rest-js": "^2.2.0",
"@azure/core-auth": "^1.1.4",
"tslib": "^1.10.0"
},
"keywords": [
Expand All @@ -20,7 +21,7 @@
"module": "./esm/azureNetAppFilesManagementClient.js",
"types": "./esm/azureNetAppFilesManagementClient.d.ts",
"devDependencies": {
"typescript": "^3.5.3",
"typescript": "^3.6.0",
"rollup": "^1.18.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
Expand Down
15 changes: 9 additions & 6 deletions sdk/netapp/arm-netapp/src/azureNetAppFilesManagementClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
*/

import * as msRest from "@azure/ms-rest-js";
import { TokenCredential } from "@azure/core-auth";
import * as Models from "./models";
import * as Mappers from "./models/mappers";
import * as operations from "./operations";
import { AzureNetAppFilesManagementClientContext } from "./azureNetAppFilesManagementClientContext";


class AzureNetAppFilesManagementClient extends AzureNetAppFilesManagementClientContext {
// Operation groups
operations: operations.Operations;
Expand All @@ -29,16 +31,17 @@ class AzureNetAppFilesManagementClient extends AzureNetAppFilesManagementClientC

/**
* Initializes a new instance of the AzureNetAppFilesManagementClient class.
* @param credentials Credentials needed for the client to connect to Azure.
* @param credentials Credentials needed for the client to connect to Azure. Credentials
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
* more information about these credentials, see
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
* @azure/ms-rest-browserauth are also supported.
* @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure
* subscription. The subscription ID forms part of the URI for every service call.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials,
subscriptionId: string,
options?: Models.AzureNetAppFilesManagementClientOptions
) {
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AzureNetAppFilesManagementClientOptions) {
super(credentials, subscriptionId, options);
this.operations = new operations.Operations(this);
this.netAppResource = new operations.NetAppResource(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,34 @@
import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import { TokenCredential } from "@azure/core-auth";

const packageName = "@azure/arm-netapp";
const packageVersion = "14.0.0";

export class AzureNetAppFilesManagementClientContext extends msRestAzure.AzureServiceClient {
credentials: msRest.ServiceClientCredentials;
credentials: msRest.ServiceClientCredentials | TokenCredential;
subscriptionId: string;
apiVersion?: string;

/**
* Initializes a new instance of the AzureNetAppFilesManagementClient class.
* @param credentials Credentials needed for the client to connect to Azure.
* @param credentials Credentials needed for the client to connect to Azure. Credentials
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
* more information about these credentials, see
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
* @azure/ms-rest-browserauth are also supported.
* @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure
* subscription. The subscription ID forms part of the URI for every service call.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials,
subscriptionId: string,
options?: Models.AzureNetAppFilesManagementClientOptions
) {
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AzureNetAppFilesManagementClientOptions) {
if (credentials == undefined) {
throw new Error("'credentials' cannot be null.");
throw new Error('\'credentials\' cannot be null.');
}
if (subscriptionId == undefined) {
throw new Error("'subscriptionId' cannot be null.");
throw new Error('\'subscriptionId\' cannot be null.');
}

if (!options) {
Expand All @@ -48,8 +50,8 @@ export class AzureNetAppFilesManagementClientContext extends msRestAzure.AzureSe

super(credentials, options);

this.apiVersion = "2021-02-01";
this.acceptLanguage = "en-US";
this.apiVersion = '2021-04-01';
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
this.requestContentType = "application/json; charset=utf-8";
Expand All @@ -59,10 +61,7 @@ export class AzureNetAppFilesManagementClientContext extends msRestAzure.AzureSe
if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
this.acceptLanguage = options.acceptLanguage;
}
if (
options.longRunningOperationRetryTimeout !== null &&
options.longRunningOperationRetryTimeout !== undefined
) {
if (options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout;
}
}
Expand Down
1 change: 1 addition & 0 deletions sdk/netapp/arm-netapp/src/models/backupsMappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export {
NetAppAccount,
NetAppAccountPatch,
ReplicationObject,
RestoreStatus,
Snapshot,
SnapshotPolicy,
SystemData,
Expand Down
Loading

0 comments on commit 4d5d088

Please sign in to comment.