You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/sql/arm-sql/README.md
+59-52Lines changed: 59 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,96 +1,103 @@
1
1
## Azure SqlManagementClient SDK for JavaScript
2
2
3
-
This package contains an isomorphic SDK for SqlManagementClient.
3
+
This package contains an isomorphic SDK (runs both in node.js and in browsers) for SqlManagementClient.
4
4
5
5
### Currently supported environments
6
6
7
-
- Node.js version 6.x.x or higher
7
+
- Node.js version 8.x.x or higher
8
8
- Browser JavaScript
9
9
10
-
### How to Install
10
+
### Prerequisites
11
11
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-sql` 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:
12
21
```bash
13
-
npm install @azure/arm-sql
22
+
npm install --save @azure/arm-sql @azure/identity
14
23
```
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.
15
26
16
27
### How to use
17
28
18
-
#### nodejs - Authentication, client creation and get recoverableDatabases 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.
19
36
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 get recoverableDatabases as an example written in JavaScript.
#### browser - Authentication, client creation and get recoverableDatabases as an example written in JavaScript.
64
+
#### browser - Authentication, client creation, and get recoverableDatabases as an example written in JavaScript.
51
65
52
-
##### Install @azure/ms-rest-browserauth
53
-
54
-
```bash
55
-
npm install @azure/ms-rest-browserauth
56
-
```
66
+
In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
67
+
- 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.
68
+
- Note down the client Id from the previous step and use it in the browser sample below.
57
69
58
70
##### Sample code
59
71
60
-
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.
0 commit comments