Skip to content

Commit 5efcbb4

Browse files
author
SDKAuto
committed
CodeGen from PR 3426 in test-repo-billy/azure-rest-api-specs
Merge 8bccee0a3743b150c13ceed41768417041adc96e into c9327ee12bede16737ba6881e54d1d72ccbaca5c
1 parent 7534cca commit 5efcbb4

26 files changed

+8958
-9
lines changed

‎common/config/rush/pnpm-lock.yaml

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

‎rush.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* This is the main configuration file for Rush.
33
* For full documentation, please see https://rushjs.io
4-
*/ {
4+
*/{
55
"$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json",
66
/**
77
* (Required) This specifies the version of the Rush engine to be used in this repo.
@@ -2246,6 +2246,11 @@
22462246
"packageName": "@azure/arm-redhatopenshift",
22472247
"projectFolder": "sdk/redhatopenshift/arm-redhatopenshift",
22482248
"versionPolicyName": "management"
2249+
},
2250+
{
2251+
"packageName": "@azure/arm-computefleet",
2252+
"projectFolder": "sdk/computefleet/arm-computefleet",
2253+
"versionPolicyName": "management"
22492254
}
22502255
]
2251-
}
2256+
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2024-07-31)
4+
5+
The package of @azure/arm-computefleet 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/computefleet/arm-computefleet/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2024 Microsoft
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/computefleet/arm-computefleet/README.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Azure MicrosoftAzureFleetForTesting client library for JavaScript
2+
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure MicrosoftAzureFleetForTesting client.
4+
5+
6+
7+
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/computefleet/arm-computefleet) |
8+
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-computefleet) |
9+
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-computefleet?view=azure-node-preview) |
10+
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
11+
12+
## Getting started
13+
14+
### Currently supported environments
15+
16+
- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
17+
- Latest versions of Safari, Chrome, Edge and Firefox.
18+
19+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
20+
21+
### Prerequisites
22+
23+
- An [Azure subscription][azure_sub].
24+
25+
### Install the `@azure/arm-computefleet` package
26+
27+
Install the Azure MicrosoftAzureFleetForTesting client library for JavaScript with `npm`:
28+
29+
```bash
30+
npm install @azure/arm-computefleet
31+
```
32+
33+
### Create and authenticate a `MicrosoftAzureFleetForTesting`
34+
35+
To create a client object to access the Azure MicrosoftAzureFleetForTesting API, you will need the `endpoint` of your Azure MicrosoftAzureFleetForTesting resource and a `credential`. The Azure MicrosoftAzureFleetForTesting client can use Azure Active Directory credentials to authenticate.
36+
You can find the endpoint for your Azure MicrosoftAzureFleetForTesting resource in the [Azure Portal][azure_portal].
37+
38+
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).
39+
40+
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
41+
42+
```bash
43+
npm install @azure/identity
44+
```
45+
46+
You will also need to **register a new AAD application and grant access to Azure MicrosoftAzureFleetForTesting** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
47+
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`.
48+
49+
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).
50+
51+
```javascript
52+
const { MicrosoftAzureFleetForTesting } = require("@azure/arm-computefleet");
53+
const { DefaultAzureCredential } = require("@azure/identity");
54+
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
55+
56+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
57+
const client = new MicrosoftAzureFleetForTesting(new DefaultAzureCredential(), subscriptionId);
58+
59+
// For client-side applications running in the browser, use this code instead:
60+
// const credential = new InteractiveBrowserCredential({
61+
// tenantId: "<YOUR_TENANT_ID>",
62+
// clientId: "<YOUR_CLIENT_ID>"
63+
// });
64+
// const client = new MicrosoftAzureFleetForTesting(credential, subscriptionId);
65+
```
66+
67+
68+
### JavaScript Bundle
69+
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).
70+
71+
## Key concepts
72+
73+
### MicrosoftAzureFleetForTesting
74+
75+
`MicrosoftAzureFleetForTesting` is the primary interface for developers using the Azure MicrosoftAzureFleetForTesting client library. Explore the methods on this client object to understand the different features of the Azure MicrosoftAzureFleetForTesting service that you can access.
76+
77+
## Troubleshooting
78+
79+
### Logging
80+
81+
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`:
82+
83+
```javascript
84+
const { setLogLevel } = require("@azure/logger");
85+
setLogLevel("info");
86+
```
87+
88+
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).
89+
90+
## Next steps
91+
92+
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.
93+
94+
## Contributing
95+
96+
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.
97+
98+
## Related projects
99+
100+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
101+
102+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcomputefleet%2Farm-computefleet%2FREADME.png)
103+
104+
[azure_cli]: https://docs.microsoft.com/cli/azure
105+
[azure_sub]: https://azure.microsoft.com/free/
106+
[azure_sub]: https://azure.microsoft.com/free/
107+
[azure_portal]: https://portal.azure.com
108+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
109+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

‎sdk/computefleet/arm-computefleet/_meta.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"commit": "536b844b64c9dbf1afde72233ba9ebba39825c0e",
3+
"readme": "specification/azurefleet/resource-manager/readme.md",
4+
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/azurefleet/resource-manager/readme.md --use=@autorest/typescript@^6.0.12",
5+
"repository_url": "https://github.com/test-repo-billy/azure-rest-api-specs.git",
6+
"release_tool": "@azure-tools/[email protected]",
7+
"use": "@autorest/typescript@^6.0.12"
8+
}

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

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/src/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": "./types/arm-computefleet.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+
}

0 commit comments

Comments
 (0)