Skip to content

Commit fa6ec8b

Browse files
azure-sdkazure-sdk
authored
[AutoPR @azure-arm-postgresqlhsc]-generated-from-SDK Generation - JS-6381305 (#38775)
Configurations: 'specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/PostgresqlHsc/tspconfig.yaml', API Version: 2023-03-02-preview, SDK Release Type: beta, and CommitSHA: '16e90365f2fcc4efaa3e67e39c15f75c3712ad3d' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6381305 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
1 parent 57c04eb commit fa6ec8b

187 files changed

Lines changed: 12900 additions & 0 deletions

File tree

Some content is hidden

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

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1679,6 +1679,9 @@ sdk/providerhub/arm-providerhub/ @qiaozha @MaryGao @JialinHuang803
16791679
sdk/monitor/arm-monitorworkspaces/ @qiaozha @MaryGao @JialinHuang803
16801680
sdk/edgeorder/arm-edgeorder/ @qiaozha @MaryGao @JialinHuang803
16811681

1682+
# PRLabel: %Mgmt %mgmt-review-needed
1683+
sdk/postgresqlhsc/arm-postgresqlhsc/ @qiaozha @MaryGao @JialinHuang803
1684+
16821685
###########
16831686
# Config
16841687
###########

‎eng/ignore-links.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,5 @@ https://learn.microsoft.com/javascript/api/@azure/arm-monitorworkspaces?view=azu
109109
https://www.npmjs.com/package/@azure/arm-monitorworkspaces
110110
https://learn.microsoft.com/javascript/api/@azure/arm-edgeorder?view=azure-node-preview
111111
https://www.npmjs.com/package/@azure/arm-edgeorder
112+
https://learn.microsoft.com/javascript/api/@azure/arm-postgresqlhsc?view=azure-node-preview
113+
https://www.npmjs.com/package/@azure/arm-postgresqlhsc

‎pnpm-lock.yaml‎

Lines changed: 79 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎sdk/postgresqlhsc/arm-postgresqlhsc/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2026-06-02)
4+
5+
### Features Added
6+
7+
This is the first preview release of the @azure/arm-postgresqlhsc package. It introduces a new SDK generation with layered APIs, smaller bundles, and improved ergonomics. For more details, see the https://aka.ms/azsdk/js/sdk/quickstart.

‎sdk/postgresqlhsc/arm-postgresqlhsc/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎sdk/postgresqlhsc/arm-postgresqlhsc/README.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Azure DBforPostgreSQL client library for JavaScript
2+
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure DBforPostgreSQL client.
4+
5+
Azure Cosmos DB for PostgreSQL database service resource provider REST APIs
6+
7+
Key links:
8+
9+
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/postgresqlhsc/arm-postgresqlhsc)
10+
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-postgresqlhsc)
11+
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-postgresqlhsc?view=azure-node-preview)
12+
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/postgresqlhsc/arm-postgresqlhsc/samples)
13+
14+
## Getting started
15+
16+
### Currently supported environments
17+
18+
- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
19+
- Latest versions of Safari, Chrome, Edge and Firefox.
20+
21+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
22+
23+
### Prerequisites
24+
25+
- An [Azure subscription][azure_sub].
26+
27+
### Install the `@azure/arm-postgresqlhsc` package
28+
29+
Install the Azure DBforPostgreSQL client library for JavaScript with `npm`:
30+
31+
```bash
32+
npm install @azure/arm-postgresqlhsc
33+
```
34+
35+
### Create and authenticate a `DBforPostgreSQLClient`
36+
37+
To create a client object to access the Azure DBforPostgreSQL API, you will need the `endpoint` of your Azure DBforPostgreSQL resource and a `credential`. The Azure DBforPostgreSQL client can use Azure Active Directory credentials to authenticate.
38+
You can find the endpoint for your Azure DBforPostgreSQL resource in the [Azure Portal][azure_portal].
39+
40+
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/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
41+
42+
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
43+
44+
```bash
45+
npm install @azure/identity
46+
```
47+
48+
You will also need to **register a new AAD application and grant access to Azure DBforPostgreSQL** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
49+
50+
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
51+
52+
Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.
53+
54+
```ts snippet:ReadmeSampleCreateClient_Node
55+
import { DBforPostgreSQLClient } from "@azure/arm-postgresqlhsc";
56+
import { DefaultAzureCredential } from "@azure/identity";
57+
58+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
59+
const client = new DBforPostgreSQLClient(new DefaultAzureCredential(), subscriptionId);
60+
```
61+
62+
For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.
63+
64+
```ts snippet:ReadmeSampleCreateClient_Browser
65+
import { InteractiveBrowserCredential } from "@azure/identity";
66+
import { DBforPostgreSQLClient } from "@azure/arm-postgresqlhsc";
67+
68+
const credential = new InteractiveBrowserCredential({
69+
tenantId: "<YOUR_TENANT_ID>",
70+
clientId: "<YOUR_CLIENT_ID>",
71+
});
72+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
73+
const client = new DBforPostgreSQLClient(credential, subscriptionId);
74+
```
75+
76+
77+
### JavaScript Bundle
78+
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
79+
80+
## Key concepts
81+
82+
### DBforPostgreSQLClient
83+
84+
`DBforPostgreSQLClient` is the primary interface for developers using the Azure DBforPostgreSQL client library. Explore the methods on this client object to understand the different features of the Azure DBforPostgreSQL service that you can access.
85+
86+
## Troubleshooting
87+
88+
### Logging
89+
90+
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
91+
92+
```ts snippet:SetLogLevel
93+
import { setLogLevel } from "@azure/logger";
94+
95+
setLogLevel("info");
96+
```
97+
98+
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/main/sdk/core/logger).
99+
100+
## Next steps
101+
102+
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/postgresqlhsc/arm-postgresqlhsc/samples) directory for detailed examples on how to use this library.
103+
104+
## Contributing
105+
106+
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
107+
108+
## Related projects
109+
110+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
111+
112+
[azure_sub]: https://azure.microsoft.com/free/
113+
[azure_portal]: https://portal.azure.com
114+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
115+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

‎sdk/postgresqlhsc/arm-postgresqlhsc/api-extractor.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{ "extends": "../../../api-extractor-base.json" }

‎sdk/postgresqlhsc/arm-postgresqlhsc/config/tsconfig.lint.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": "../../../../tsconfig.json",
3+
"include": ["../src", "../test"]
4+
}

‎sdk/postgresqlhsc/arm-postgresqlhsc/config/tsconfig.samples.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"extends": "../../../../eng/tsconfigs/samples.json",
3+
"compilerOptions": {
4+
"paths": {
5+
"@azure/arm-postgresqlhsc": ["../dist/esm"]
6+
}
7+
}
8+
}

‎sdk/postgresqlhsc/arm-postgresqlhsc/config/tsconfig.snippets.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "../../../../eng/tsconfigs/snippets.json"
3+
}

0 commit comments

Comments
 (0)