Skip to content

Commit 4fe6dfd

Browse files
author
SDKAuto
committed
CodeGen from PR 15050 in Azure/azure-rest-api-specs
Merge af44661236b6a92f7eb938f69d3b09c1bfb032f5 into b5b3ae9a081535b4dabce52a1136eece3e2d469f
1 parent 899fc0a commit 4fe6dfd

24 files changed

+1612
-296
lines changed

sdk/redis/arm-rediscache/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) 2020 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/redis/arm-rediscache/README.md

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,97 @@
11
## Azure RedisManagementClient SDK for JavaScript
22

3-
This package contains an isomorphic SDK for RedisManagementClient.
3+
This package contains an isomorphic SDK (runs both in node.js and in browsers) for RedisManagementClient.
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-rediscache` 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-rediscache
22+
npm install --save @azure/arm-rediscache @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 operations 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 operations 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 { RedisManagementClient, RedisManagementModels, RedisManagementMappers } from "@azure/arm-rediscache";
43+
```javascript
44+
const { DefaultAzureCredential } = require("@azure/identity");
45+
const { RedisManagementClient } = require("@azure/arm-rediscache");
3446
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
3547

36-
msRestNodeAuth.interactiveLogin().then((creds) => {
37-
const client = new RedisManagementClient(creds, subscriptionId);
38-
client.operations.list().then((result) => {
39-
console.log("The result is:");
40-
console.log(result);
41-
});
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 RedisManagementClient(creds, subscriptionId);
52+
client.operations.list().then((result) => {
53+
console.log("The result is:");
54+
console.log(result);
4255
}).catch((err) => {
56+
console.log("An error occurred:");
4357
console.error(err);
4458
});
4559
```
4660

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

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

5567
##### Sample code
5668

57-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
58-
5969
- index.html
70+
6071
```html
6172
<!DOCTYPE html>
6273
<html lang="en">
6374
<head>
6475
<title>@azure/arm-rediscache sample</title>
65-
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
6676
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
67-
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
77+
<script src="node_modules/@azure/identity/dist/index.js"></script>
6878
<script src="node_modules/@azure/arm-rediscache/dist/arm-rediscache.js"></script>
6979
<script type="text/javascript">
7080
const subscriptionId = "<Subscription_Id>";
71-
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+
{
7285
clientId: "<client id for your Azure AD app>",
7386
tenant: "<optional tenant for your organization>"
7487
});
75-
authManager.finalizeLogin().then((res) => {
76-
if (!res.isLoggedIn) {
77-
// may cause redirects
78-
authManager.login();
79-
}
80-
const client = new Azure.ArmRediscache.RedisManagementClient(res.creds, subscriptionId);
81-
client.operations.list().then((result) => {
82-
console.log("The result is:");
83-
console.log(result);
84-
}).catch((err) => {
85-
console.log("An error occurred:");
86-
console.error(err);
87-
});
88+
const client = new Azure.ArmRediscache.RedisManagementClient(creds, subscriptionId);
89+
client.operations.list().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);
8895
});
8996
</script>
9097
</head>

sdk/redis/arm-rediscache/package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
"description": "RedisManagementClient Library with typescript type definitions for node.js and browser.",
55
"version": "4.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,13 +21,13 @@
2021
"module": "./esm/redisManagementClient.js",
2122
"types": "./esm/redisManagementClient.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",
2728
"uglify-js": "^3.6.0"
2829
},
29-
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/redis/arm-rediscache",
30+
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/redis/arm-rediscache",
3031
"repository": {
3132
"type": "git",
3233
"url": "https://github.com/Azure/azure-sdk-for-js.git"

sdk/redis/arm-rediscache/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/redis/arm-rediscache/src/models/firewallRulesMappers.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
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.
77
*/
88

99
export {
10+
AzureEntityResource,
1011
BaseResource,
11-
CloudError,
12+
ErrorAdditionalInfo,
13+
ErrorDetail,
14+
ErrorResponse,
15+
PrivateEndpoint,
16+
PrivateEndpointConnection,
17+
PrivateLinkResource,
18+
PrivateLinkServiceConnectionState,
1219
ProxyResource,
1320
RedisAccessKeys,
1421
RedisFirewallRule,

0 commit comments

Comments
 (0)