Skip to content

Commit

Permalink
CodeGen from PR 31188 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge 01289db756c2a77e598e11e1d8e9fb30a8674dd1 into dc7fc9849b622c2a0b3ce5e10746ceb4057ad759
  • Loading branch information
SDKAuto committed Jan 10, 2025
1 parent a12227f commit c53318f
Show file tree
Hide file tree
Showing 106 changed files with 979 additions and 3,566 deletions.
40 changes: 13 additions & 27 deletions common/config/rush/pnpm-lock.yaml

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

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

## 1.0.2 (Unreleased)

## 2.0.0 (2025-01-10)
### Features Added

### Breaking Changes
- Added Enum KnownVersions
- Enum KnownOrigin has a new value "user,system"
- Enum KnownOrigin has a new value system
- Enum KnownOrigin has a new value user
- Enum KnownRefillPolicy has a new value always

### Bugs Fixed

### Other Changes
### Breaking Changes

- Enum KnownOrigin no longer has value System
- Enum KnownOrigin no longer has value User
- Enum KnownOrigin no longer has value UserSystem
- Enum KnownRefillPolicy no longer has value Always

## 1.0.1 (2024-11-04)

### Bugs Fixed
Expand Down
2 changes: 1 addition & 1 deletion sdk/standbypool/arm-standbypool/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2024 Microsoft
Copyright (c) 2025 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
39 changes: 21 additions & 18 deletions sdk/standbypool/arm-standbypool/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Azure StandbyPoolManagement client library for JavaScript
# Azure StandbyPool client library for JavaScript

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

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


Key links:

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

## Getting started

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

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

Install the Azure StandbyPoolManagement client library for JavaScript with `npm`:
Install the Azure StandbyPool client library for JavaScript with `npm`:

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

### Create and authenticate a `StandbyPoolManagementClient`
### Create and authenticate a `StandbyPoolClient`

To create a client object to access the Azure StandbyPoolManagement API, you will need the `endpoint` of your Azure StandbyPoolManagement resource and a `credential`. The Azure StandbyPoolManagement client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure StandbyPoolManagement resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure StandbyPool API, you will need the `endpoint` of your Azure StandbyPool resource and a `credential`. The Azure StandbyPool client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure StandbyPool 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,35 +45,34 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure StandbyPool** 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://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
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 { StandbyPoolManagementClient } = require("@azure/arm-standbypool");
const { StandbyPoolClient } = require("@azure/arm-standbypool");
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 StandbyPoolManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new StandbyPoolClient(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 StandbyPoolManagementClient(credential, subscriptionId);
// const client = new StandbyPoolClient(credential, subscriptionId);
```

### JavaScript Bundle

### JavaScript Bundle
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).

## Key concepts

### StandbyPoolManagementClient
### StandbyPoolClient

`StandbyPoolManagementClient` is the primary interface for developers using the Azure StandbyPoolManagement client library. Explore the methods on this client object to understand the different features of the Azure StandbyPoolManagement service that you can access.
`StandbyPoolClient` is the primary interface for developers using the Azure StandbyPool client library. Explore the methods on this client object to understand the different features of the Azure StandbyPool service that you can access.

## Troubleshooting

Expand All @@ -85,6 +87,7 @@ 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).


## Contributing

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.
Expand Down
27 changes: 20 additions & 7 deletions sdk/standbypool/arm-standbypool/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/index.d.ts",
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-standbypool.d.ts"
"publicTrimmedFilePath": "dist/arm-standbypool.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/standbypool/arm-standbypool/assets.json

This file was deleted.

17 changes: 17 additions & 0 deletions sdk/standbypool/arm-standbypool/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 c53318f

Please sign in to comment.