Skip to content

Commit c19da77

Browse files
committed
Update docs metadata
1 parent b38e3e9 commit c19da77

File tree

2 files changed

+35
-26
lines changed

2 files changed

+35
-26
lines changed
Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
---
2-
title: Azure PostgreSQLManagement client library for JavaScript
2+
title: Azure PostgreSQLManagementFlexibleServer client library for JavaScript
33
keywords: Azure, javascript, SDK, API, @azure/arm-postgresql-flexible, postgresql
44
author: qiaozha
55
ms.author: qiaozha
6-
ms.date: 01/20/2022
6+
ms.date: 04/29/2022
77
ms.topic: reference
8-
ms.prod: azure
9-
ms.technology: azure
108
ms.devlang: javascript
119
ms.service: postgresql
1210
---
13-
# Azure PostgreSQLManagement client library for JavaScript - Version 5.0.0
11+
# Azure PostgreSQLManagementFlexibleServer client library for JavaScript - Version 6.0.0
1412

1513

16-
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure PostgreSQLManagement client.
14+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure PostgreSQLManagementFlexibleServer client.
1715

1816
The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.
1917

20-
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_5.0.0/sdk/postgresql/arm-postgresql-flexible) |
18+
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_6.0.0/sdk/postgresql/arm-postgresql-flexible) |
2119
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-postgresql-flexible) |
22-
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-postgresql-flexible) |
20+
[API reference documentation](/javascript/api/@azure/arm-postgresql-flexible) |
2321
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
2422

2523
## Getting started
@@ -29,41 +27,52 @@ The Microsoft Azure management API provides create, read, update, and delete fun
2927
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
3028
- Latest versions of Safari, Chrome, Edge and Firefox.
3129

30+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-postgresql-flexible_6.0.0/SUPPORT.md) for more details.
31+
3232
### Prerequisites
3333

3434
- An [Azure subscription][azure_sub].
3535

3636
### Install the `@azure/arm-postgresql-flexible` package
3737

38-
Install the Azure PostgreSQLManagement client library for JavaScript with `npm`:
38+
Install the Azure PostgreSQLManagementFlexibleServer client library for JavaScript with `npm`:
3939

4040
```bash
4141
npm install @azure/arm-postgresql-flexible
4242
```
4343

44-
### Create and authenticate a `PostgreSQLManagementClient`
44+
### Create and authenticate a `PostgreSQLManagementFlexibleServerClient`
4545

46-
To create a client object to access the Azure PostgreSQLManagement API, you will need the `endpoint` of your Azure PostgreSQLManagement resource and a `credential`. The Azure PostgreSQLManagement client can use Azure Active Directory credentials to authenticate.
47-
You can find the endpoint for your Azure PostgreSQLManagement resource in the [Azure Portal][azure_portal].
46+
To create a client object to access the Azure PostgreSQLManagementFlexibleServer API, you will need the `endpoint` of your Azure PostgreSQLManagementFlexibleServer resource and a `credential`. The Azure PostgreSQLManagementFlexibleServer client can use Azure Active Directory credentials to authenticate.
47+
You can find the endpoint for your Azure PostgreSQLManagementFlexibleServer resource in the [Azure Portal][azure_portal].
4848

49-
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-postgresql-flexible_5.0.0/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
49+
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-postgresql-flexible_6.0.0/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
5050

5151
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
5252

5353
```bash
5454
npm install @azure/identity
5555
```
5656

57-
You will also need to **register a new AAD application and grant access to Azure PostgreSQLManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
57+
You will also need to **register a new AAD application and grant access to Azure PostgreSQLManagementFlexibleServer** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
5858
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
5959

60-
For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
60+
For more information about how to create an Azure AD Application check out [this guide](/azure/active-directory/develop/howto-create-service-principal-portal).
6161

6262
```javascript
63-
const { PostgreSQLManagementClient } = require("@azure/arm-postgresql-flexible");
63+
const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
6464
const { DefaultAzureCredential } = require("@azure/identity");
65+
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
66+
6567
const subscriptionId = "00000000-0000-0000-0000-000000000000";
66-
const client = new PostgreSQLManagementClient(new DefaultAzureCredential(), subscriptionId);
68+
const client = new PostgreSQLManagementFlexibleServerClient(new DefaultAzureCredential(), subscriptionId);
69+
70+
// For client-side applications running in the browser, use this code instead:
71+
// const credential = new InteractiveBrowserCredential({
72+
// tenantId: "<YOUR_TENANT_ID>",
73+
// clientId: "<YOUR_CLIENT_ID>"
74+
// });
75+
// const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
6776
```
6877

6978

@@ -72,9 +81,9 @@ To use this client library in the browser, first you need to use a bundler. For
7281

7382
## Key concepts
7483

75-
### PostgreSQLManagementClient
84+
### PostgreSQLManagementFlexibleServerClient
7685

77-
`PostgreSQLManagementClient` is the primary interface for developers using the Azure PostgreSQLManagement client library. Explore the methods on this client object to understand the different features of the Azure PostgreSQLManagement service that you can access.
86+
`PostgreSQLManagementFlexibleServerClient` is the primary interface for developers using the Azure PostgreSQLManagementFlexibleServer client library. Explore the methods on this client object to understand the different features of the Azure PostgreSQLManagementFlexibleServer service that you can access.
7887

7988
## Troubleshooting
8089

@@ -87,26 +96,26 @@ const { setLogLevel } = require("@azure/logger");
8796
setLogLevel("info");
8897
```
8998

90-
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_5.0.0/sdk/core/logger).
99+
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_6.0.0/sdk/core/logger).
91100

92101
## Next steps
93102

94103
Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.
95104

96105
## Contributing
97106

98-
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-postgresql-flexible_5.0.0/CONTRIBUTING.md) to learn more about how to build and test the code.
107+
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-postgresql-flexible_6.0.0/CONTRIBUTING.md) to learn more about how to build and test the code.
99108

100109
## Related projects
101110

102111
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
103112

104113
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fpostgresql%2Farm-postgresql-flexible%2FREADME.png)
105114

106-
[azure_cli]: https://docs.microsoft.com/cli/azure
115+
[azure_cli]: /cli/azure
107116
[azure_sub]: https://azure.microsoft.com/free/
108117
[azure_sub]: https://azure.microsoft.com/free/
109118
[azure_portal]: https://portal.azure.com
110-
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_5.0.0/sdk/identity/identity
111-
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_5.0.0/sdk/identity/identity#defaultazurecredential
119+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_6.0.0/sdk/identity/identity
120+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-postgresql-flexible_6.0.0/sdk/identity/identity#defaultazurecredential
112121

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "@azure/arm-postgresql-flexible",
3-
"Version": "5.0.0",
3+
"Version": "6.0.0",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/postgresql/arm-postgresql-flexible",
66
"ServiceDirectory": "postgresql",
@@ -10,5 +10,5 @@
1010
"SdkType": "mgmt",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-arm-postgresql-flexible",
13-
"ReleaseStatus": "2022-01-20"
13+
"ReleaseStatus": "2022-04-28"
1414
}

0 commit comments

Comments
 (0)