Skip to content

Commit

Permalink
CodeGen from PR 31422 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge 542c252d0ef13668bac0f11a035554854e98bc87 into 836e5f8f4b344700f1b6d35c3ec50ce2c2b176bf
  • Loading branch information
SDKAuto committed Nov 26, 2024
1 parent bcf6917 commit 2f19d0e
Show file tree
Hide file tree
Showing 102 changed files with 4,661 additions and 8,197 deletions.
30 changes: 26 additions & 4 deletions common/config/rush/pnpm-lock.yaml

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

15 changes: 0 additions & 15 deletions sdk/devopsinfrastructure/arm-devopsinfrastructure/CHANGELOG.md

This file was deleted.

39 changes: 16 additions & 23 deletions sdk/devopsinfrastructure/arm-devopsinfrastructure/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Azure ManagedDevOpsInfrastructure client library for JavaScript
# Azure DevOpsInfrastructure client library for JavaScript

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



[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devopsinfrastructure/arm-devopsinfrastructure) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-devopsinfrastructure) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-devopsinfrastructure?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-devopsinfrastructure)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-devopsinfrastructure?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-devopsinfrastructure` package

Install the Azure ManagedDevOpsInfrastructure client library for JavaScript with `npm`:
Install the Azure DevOpsInfrastructure client library for JavaScript with `npm`:

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

### Create and authenticate a `ManagedDevOpsInfrastructure`
### Create and authenticate a `DevOpsInfrastructureClient`

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

### ManagedDevOpsInfrastructure
### DevOpsInfrastructureClient

`ManagedDevOpsInfrastructure` is the primary interface for developers using the Azure ManagedDevOpsInfrastructure client library. Explore the methods on this client object to understand the different features of the Azure ManagedDevOpsInfrastructure service that you can access.
`DevOpsInfrastructureClient` is the primary interface for developers using the Azure DevOpsInfrastructure client library. Explore the methods on this client object to understand the different features of the Azure DevOpsInfrastructure 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%2Fdevopsinfrastructure%2Farm-devopsinfrastructure%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/devopsinfrastructure/arm-devopsinfrastructure/_meta.json

This file was deleted.

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-devopsinfrastructure.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/devopsinfrastructure/arm-devopsinfrastructure/assets.json

This file was deleted.

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 2f19d0e

Please sign in to comment.