Skip to content

Commit 03fdba6

Browse files
author
SDKAuto
committed
CodeGen from PR 15016 in Azure/azure-rest-api-specs
Changes to fix the Resource Provider name casing issue for Azure Postgres, MySQL and MariaDB (Azure#15016) * Changes to fix the Resource provided name casing issue for Azure Postgres, MySQL and MariaDB services * Changes to fix the Resource provided name casing issue for Azure Postgres, MySQL and MariaDB services * Revert "Changes to fix the Resource provided name casing issue for Azure Postgres, MySQL and MariaDB services" This reverts commit ecc38dc560b77de750350143fd80bdd6e3823882.
1 parent 3bcdc0b commit 03fdba6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+6313
-560
lines changed

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

Lines changed: 59 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,101 @@
11
## Azure MariaDBManagementClient SDK for JavaScript
22

3-
This package contains an isomorphic SDK for MariaDBManagementClient.
3+
This package contains an isomorphic SDK (runs both in node.js and in browsers) for MariaDBManagementClient.
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-mariadb` 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-mariadb
22+
npm install --save @azure/arm-mariadb @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 get servers 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 get servers 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 { MariaDBManagementClient, MariaDBManagementModels, MariaDBManagementMappers } from "@azure/arm-mariadb";
43+
```javascript
44+
const { DefaultAzureCredential } = require("@azure/identity");
45+
const { MariaDBManagementClient } = require("@azure/arm-mariadb");
3346
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
3447

35-
msRestNodeAuth.interactiveLogin().then((creds) => {
36-
const client = new MariaDBManagementClient(creds, subscriptionId);
37-
const resourceGroupName = "testresourceGroupName";
38-
const serverName = "testserverName";
39-
client.servers.get(resourceGroupName, serverName).then((result) => {
40-
console.log("The result is:");
41-
console.log(result);
42-
});
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 MariaDBManagementClient(creds, subscriptionId);
52+
const resourceGroupName = "testresourceGroupName";
53+
const serverName = "testserverName";
54+
client.servers.get(resourceGroupName, serverName).then((result) => {
55+
console.log("The result is:");
56+
console.log(result);
4357
}).catch((err) => {
58+
console.log("An error occurred:");
4459
console.error(err);
4560
});
4661
```
4762

48-
#### browser - Authentication, client creation and get servers as an example written in JavaScript.
63+
#### browser - Authentication, client creation, and get servers as an example written in JavaScript.
4964

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

5669
##### Sample code
5770

58-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
59-
6071
- index.html
72+
6173
```html
6274
<!DOCTYPE html>
6375
<html lang="en">
6476
<head>
6577
<title>@azure/arm-mariadb sample</title>
66-
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
6778
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
68-
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
79+
<script src="node_modules/@azure/identity/dist/index.js"></script>
6980
<script src="node_modules/@azure/arm-mariadb/dist/arm-mariadb.js"></script>
7081
<script type="text/javascript">
7182
const subscriptionId = "<Subscription_Id>";
72-
const authManager = new msAuth.AuthManager({
83+
// Create credentials using the `@azure/identity` package.
84+
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
85+
const credential = new InteractiveBrowserCredential(
86+
{
7387
clientId: "<client id for your Azure AD app>",
7488
tenant: "<optional tenant for your organization>"
7589
});
76-
authManager.finalizeLogin().then((res) => {
77-
if (!res.isLoggedIn) {
78-
// may cause redirects
79-
authManager.login();
80-
}
81-
const client = new Azure.ArmMariadb.MariaDBManagementClient(res.creds, subscriptionId);
82-
const resourceGroupName = "testresourceGroupName";
83-
const serverName = "testserverName";
84-
client.servers.get(resourceGroupName, serverName).then((result) => {
85-
console.log("The result is:");
86-
console.log(result);
87-
}).catch((err) => {
88-
console.log("An error occurred:");
89-
console.error(err);
90-
});
90+
const client = new Azure.ArmMariadb.MariaDBManagementClient(creds, subscriptionId);
91+
const resourceGroupName = "testresourceGroupName";
92+
const serverName = "testserverName";
93+
client.servers.get(resourceGroupName, serverName).then((result) => {
94+
console.log("The result is:");
95+
console.log(result);
96+
}).catch((err) => {
97+
console.log("An error occurred:");
98+
console.error(err);
9199
});
92100
</script>
93101
</head>
@@ -99,4 +107,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to
99107

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

102-
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fmariadb%2Farm-mariadb%2FREADME.png)
110+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/mariadb/arm-mariadb/README.png)

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
"description": "MariaDBManagementClient Library with typescript type definitions for node.js and browser.",
55
"version": "1.4.0",
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",
@@ -20,13 +21,13 @@
2021
"module": "./esm/mariaDBManagementClient.js",
2122
"types": "./esm/mariaDBManagementClient.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/mariadb/arm-mariadb",
30+
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/mariadb/arm-mariadb",
3031
"repository": {
3132
"type": "git",
3233
"url": "https://github.com/Azure/azure-sdk-for-js.git"

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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
};

0 commit comments

Comments
 (0)