Skip to content

Commit

Permalink
CodeGen from PR 31543 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge fec6882b306f1860eec64898d3663202abb8d42f into 63d530d0def1c624f5d42d39170ff4ac196522e2
  • Loading branch information
SDKAuto committed Nov 14, 2024
1 parent 86ed16f commit 02d2287
Show file tree
Hide file tree
Showing 76 changed files with 3,270 additions and 4,579 deletions.
28 changes: 25 additions & 3 deletions common/config/rush/pnpm-lock.yaml

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

14 changes: 3 additions & 11 deletions sdk/astro/arm-astro/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
# Release History

## 1.0.0-beta.2 (Unreleased)
## 1.0.0 (2024-11-14)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes

## 1.0.0-beta.1 (2024-02-07)

The package of @azure/arm-astro is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
The package of @azure/arm-astro is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
39 changes: 16 additions & 23 deletions sdk/astro/arm-astro/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Azure AstroManagement client library for JavaScript
# Azure Astro client library for JavaScript

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



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

- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-astro)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-astro?view=azure-node-preview)

## Getting started

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

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

Install the Azure AstroManagement client library for JavaScript with `npm`:
Install the Azure Astro client library for JavaScript with `npm`:

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

### Create and authenticate a `AstroManagementClient`
### Create and authenticate a `AstroClient`

To create a client object to access the Azure AstroManagement API, you will need the `endpoint` of your Azure AstroManagement resource and a `credential`. The Azure AstroManagement client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure AstroManagement resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure Astro API, you will need the `endpoint` of your Azure Astro resource and a `credential`. The Azure Astro client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Astro 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 @@ -43,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 Azure AstroManagement** 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 Astro** 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 { AstroManagementClient } = require("@azure/arm-astro");
const { AstroClient } = require("@azure/arm-astro");
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 AstroManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new AstroClient(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 AstroManagementClient(credential, subscriptionId);
// const client = new AstroClient(credential, subscriptionId);
```


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

## Key concepts

### AstroManagementClient
### AstroClient

`AstroManagementClient` is the primary interface for developers using the Azure AstroManagement client library. Explore the methods on this client object to understand the different features of the Azure AstroManagement service that you can access.
`AstroClient` is the primary interface for developers using the Azure Astro client library. Explore the methods on this client object to understand the different features of the Azure Astro service that you can access.

## Troubleshooting

Expand All @@ -87,9 +87,6 @@ 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 @@ -99,10 +96,6 @@ 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%2Fastro%2Farm-astro%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: 0 additions & 8 deletions sdk/astro/arm-astro/_meta.json

This file was deleted.

27 changes: 7 additions & 20 deletions sdk/astro/arm-astro/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,31 +1,18 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
"docModel": { "enabled": true },
"apiReport": { "enabled": true, "reportFolder": "./review" },
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-astro.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/astro/arm-astro/assets.json

This file was deleted.

17 changes: 17 additions & 0 deletions sdk/astro/arm-astro/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";

export default [
...azsdkEslint.configs.recommended,
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-module": "off",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn"
}
}
];
Loading

0 comments on commit 02d2287

Please sign in to comment.