Skip to content
This repository was archived by the owner on Aug 26, 2025. It is now read-only.

Commit 1d383bf

Browse files
author
SDKAuto
committed
CodeGen from PR 3638 in test-repo-billy/azure-rest-api-specs
Merge b17e26e24760e3b6443fb2a88a4f8e8ca9db7e90 into d54fc8f349c82c6854de316e16ecbed06791b162
1 parent bfe5035 commit 1d383bf

Some content is hidden

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

47 files changed

+2920
-4
lines changed

common/config/rush/pnpm-lock.yaml

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

rush.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2331,6 +2331,11 @@
23312331
"packageName": "@azure/arm-databasewatcher",
23322332
"projectFolder": "sdk/databasewatcher/arm-databasewatcher",
23332333
"versionPolicyName": "management"
2334+
},
2335+
{
2336+
"packageName": "@azure/arm-contoso",
2337+
"projectFolder": "sdk/contoso/arm-contoso",
2338+
"versionPolicyName": "management"
23342339
}
23352340
]
23362341
}
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 (2025-03-14)
4+
5+
### Features Added
6+
7+
The package of @azure/arm-contoso is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).

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

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Azure Contoso client library for JavaScript
2+
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Contoso client.
4+
5+
Microsoft.Contoso Resource Provider management API.
6+
7+
Key links:
8+
9+
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/contoso/arm-contoso)
10+
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-contoso)
11+
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-contoso?view=azure-node-preview)
12+
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/contoso/arm-contoso/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-contoso` package
28+
29+
Install the Azure Contoso client library for JavaScript with `npm`:
30+
31+
```bash
32+
npm install @azure/arm-contoso
33+
```
34+
35+
### Create and authenticate a `ContosoClient`
36+
37+
To create a client object to access the Azure Contoso API, you will need the `endpoint` of your Azure Contoso resource and a `credential`. The Azure Contoso client can use Azure Active Directory credentials to authenticate.
38+
You can find the endpoint for your Azure Contoso 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/master/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 Contoso** 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 { ContosoClient } from "@azure/arm-contoso";
56+
import { DefaultAzureCredential } from "@azure/identity";
57+
58+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
59+
const client = new ContosoClient(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 { ContosoClient } from "@azure/arm-contoso";
67+
68+
const credential = new InteractiveBrowserCredential({
69+
tenantId: "<YOUR_TENANT_ID>",
70+
clientId: "<YOUR_CLIENT_ID>"
71+
});
72+
const client = new ContosoClient(credential, subscriptionId);
73+
```
74+
75+
76+
### JavaScript Bundle
77+
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).
78+
79+
## Key concepts
80+
81+
### ContosoClient
82+
83+
`ContosoClient` is the primary interface for developers using the Azure Contoso client library. Explore the methods on this client object to understand the different features of the Azure Contoso service that you can access.
84+
85+
## Troubleshooting
86+
87+
### Logging
88+
89+
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`:
90+
91+
```ts snippet:SetLogLevel
92+
import { setLogLevel } from "@azure/logger";
93+
94+
setLogLevel("info");
95+
```
96+
97+
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).
98+
99+
## Next steps
100+
101+
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/contoso/arm-contoso/samples) directory for detailed examples on how to use this library.
102+
103+
## Contributing
104+
105+
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.
106+
107+
## Related projects
108+
109+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
110+
111+
[azure_sub]: https://azure.microsoft.com/free/
112+
[azure_portal]: https://portal.azure.com
113+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
114+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
"mainEntryPointFilePath": "dist/esm/index.d.ts",
4+
"docModel": {
5+
"enabled": true
6+
},
7+
"apiReport": {
8+
"enabled": true,
9+
"reportFolder": "./review"
10+
},
11+
"dtsRollup": {
12+
"enabled": true,
13+
"untrimmedFilePath": "",
14+
"publicTrimmedFilePath": "dist/arm-contoso.d.ts"
15+
},
16+
"messages": {
17+
"tsdocMessageReporting": {
18+
"default": {
19+
"logLevel": "none"
20+
}
21+
},
22+
"extractorMessageReporting": {
23+
"ae-missing-release-tag": {
24+
"logLevel": "none"
25+
},
26+
"ae-unresolved-link": {
27+
"logLevel": "none"
28+
}
29+
}
30+
}
31+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";
2+
3+
export default azsdkEslint.config([
4+
{
5+
rules: {
6+
"@azure/azure-sdk/ts-modules-only-named": "warn",
7+
"@azure/azure-sdk/ts-package-json-types": "warn",
8+
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
9+
"@azure/azure-sdk/ts-package-json-files-required": "off",
10+
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
11+
"tsdoc/syntax": "warn",
12+
},
13+
},
14+
]);

0 commit comments

Comments
 (0)