Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 15 additions & 20 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions sdk/computefleet/arm-computefleet/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Release History

## 1.0.0-beta.1 (2024-07-22)
## 1.0.0 (2024-10-04)

### Features Added

Initial release of the Azure Compute Fleet package
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).
36 changes: 22 additions & 14 deletions sdk/computefleet/arm-computefleet/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# AzureFleet client library for JavaScript
# Azure MicrosoftAzureFleet client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure MicrosoftAzureFleet client.

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for AzureFleet client.

Azure Fleet Service

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/computefleet/arm-computefleet) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-computefleet) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-computefleet?view=azure-node-preview) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-computefleet) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started

Expand All @@ -23,16 +24,16 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-computefleet` package

Install the AzureFleet client library for JavaScript with `npm`:
Install the Azure MicrosoftAzureFleet client library for JavaScript with `npm`:

```bash
npm install @azure/arm-computefleet
```

### Create and authenticate a `AzureFleetClient`
### Create and authenticate a `MicrosoftAzureFleet`

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

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).

Expand All @@ -42,25 +43,25 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to AzureFleet** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
You will also need to **register a new AAD application and grant access to Azure MicrosoftAzureFleet** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
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`.

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).

```javascript
const { AzureFleetClient } = require("@azure/arm-computefleet");
const { MicrosoftAzureFleet } = require("@azure/arm-computefleet");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AzureFleetClient(new DefaultAzureCredential(), subscriptionId);
const client = new MicrosoftAzureFleet(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new AzureFleetClient(credential, subscriptionId);
// const client = new MicrosoftAzureFleet(credential, subscriptionId);
```


Expand All @@ -69,9 +70,9 @@ To use this client library in the browser, first you need to use a bundler. For

## Key concepts

### AzureFleetClient
### MicrosoftAzureFleet

`AzureFleetClient` is the primary interface for developers using the AzureFleet client library. Explore the methods on this client object to understand the different features of the AzureFleet service that you can access.
`MicrosoftAzureFleet` is the primary interface for developers using the Azure MicrosoftAzureFleet client library. Explore the methods on this client object to understand the different features of the Azure MicrosoftAzureFleet service that you can access.

## Troubleshooting

Expand All @@ -86,6 +87,9 @@ setLogLevel("info");

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).

## Next steps

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.

## Contributing

Expand All @@ -95,6 +99,10 @@ If you'd like to contribute to this library, please read the [contributing guide

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

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcomputefleet%2Farm-computefleet%2FREADME.png)

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
Expand Down
8 changes: 8 additions & 0 deletions sdk/computefleet/arm-computefleet/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"commit": "f7b24fd29049a522e1fd5bca95fd80a73b70bb76",
"readme": "specification/azurefleet/resource-manager/readme.md",
"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",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.14",
"use": "@autorest/typescript@^6.0.12"
}
27 changes: 20 additions & 7 deletions sdk/computefleet/arm-computefleet/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
"docModel": { "enabled": true },
"apiReport": { "enabled": true, "reportFolder": "./review" },
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-computefleet.d.ts"
},
"messages": {
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
},
"extractorMessageReporting": {
"ae-missing-release-tag": { "logLevel": "none" },
"ae-unresolved-link": { "logLevel": "none" }
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
}
}
}
}
6 changes: 0 additions & 6 deletions sdk/computefleet/arm-computefleet/assets.json

This file was deleted.

17 changes: 0 additions & 17 deletions sdk/computefleet/arm-computefleet/eslint.config.mjs

This file was deleted.

Loading