Skip to content

Commit

Permalink
CodeGen from PR 3461 in test-repo-billy/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge ae371fa064dfef97d1ae6ed7d1d0ca24e23d11c1 into 280602975898abe4f5acc57b440b5057c3fbf1f8
  • Loading branch information
SDKAuto committed Aug 9, 2024
1 parent 4aee463 commit fa5febd
Show file tree
Hide file tree
Showing 160 changed files with 6,527 additions and 15,391 deletions.
815 changes: 416 additions & 399 deletions common/config/rush/pnpm-lock.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"plugins": ["@azure/azure-sdk"],
"extends": ["plugin:@azure/azure-sdk/azure-sdk-base"],
"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",
"tsdoc/syntax": "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"
}
}

This file was deleted.

95 changes: 23 additions & 72 deletions sdk/appcomplianceautomation/arm-appcomplianceautomation/README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,48 @@
# Azure AppComplianceAutomationToolForMicrosoft365 client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure AppComplianceAutomationToolForMicrosoft365 client.
# Azure AppComplianceAutomation REST client library for JavaScript

App Compliance Automation Tool for Microsoft 365 API spec

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appcomplianceautomation/arm-appcomplianceautomation) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-appcomplianceautomation) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-appcomplianceautomation) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
**If you are not familiar with our REST client, please spend 5 minutes to take a look at our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library, the REST client provides a light-weighted & developer friendly way to call azure rest api

Key links:

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

## Getting started

### Currently supported environments

- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
- Latest versions of Safari, Chrome, Edge and Firefox.

See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
- LTS versions of Node.js

### Prerequisites

- An [Azure subscription][azure_sub].
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.

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

Install the Azure AppComplianceAutomationToolForMicrosoft365 client library for JavaScript with `npm`:
Install the Azure AppComplianceAutomation REST client REST client library for JavaScript with `npm`:

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

### Create and authenticate a `AppComplianceAutomationToolForMicrosoft365`
### Create and authenticate a `AppComplianceAutomationClient`

To create a client object to access the Azure AppComplianceAutomationToolForMicrosoft365 API, you will need the `endpoint` of your Azure AppComplianceAutomationToolForMicrosoft365 resource and a `credential`. The Azure AppComplianceAutomationToolForMicrosoft365 client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure AppComplianceAutomationToolForMicrosoft365 resource in the [Azure Portal][azure_portal].
To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
provide an instance of the desired credential type obtained from the
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.

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

To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:

```bash
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure AppComplianceAutomationToolForMicrosoft365** 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 { AppComplianceAutomationToolForMicrosoft365 } = require("@azure/arm-appcomplianceautomation");
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 client = new AppComplianceAutomationToolForMicrosoft365(new DefaultAzureCredential());

// 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 AppComplianceAutomationToolForMicrosoft365(credential);
```
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)

After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
can be used to authenticate the client.

### 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

### AppComplianceAutomationToolForMicrosoft365

`AppComplianceAutomationToolForMicrosoft365` is the primary interface for developers using the Azure AppComplianceAutomationToolForMicrosoft365 client library. Explore the methods on this client object to understand the different features of the Azure AppComplianceAutomationToolForMicrosoft365 service that you can access.
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

## Troubleshooting

Expand All @@ -81,28 +52,8 @@ Enabling logging may help uncover useful information about failures. In order to

```javascript
const { setLogLevel } = require("@azure/logger");

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

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.

## Related projects

- [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%2Fappcomplianceautomation%2Farm-appcomplianceautomation%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
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

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-appcomplianceautomation.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" }
}
}
}
}

This file was deleted.

Loading

0 comments on commit fa5febd

Please sign in to comment.