Skip to content

Commit 34d0657

Browse files
author
SDKAuto
committed
CodeGen from PR 3482 in test-repo-billy/azure-rest-api-specs
Merge 6c7f4231c72f34d93168540dea930f470444330e into 2b91022c223ed3618c268c750f831b76fe0f4fb5
1 parent 6036699 commit 34d0657

File tree

161 files changed

+7015
-15366
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

161 files changed

+7015
-15366
lines changed

common/config/rush/pnpm-lock.yaml

Lines changed: 422 additions & 402 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/appcomplianceautomation/arm-appcomplianceautomation/CHANGELOG.md

Lines changed: 450 additions & 8 deletions
Large diffs are not rendered by default.
Lines changed: 21 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,46 @@
1-
# Azure AppComplianceAutomationToolForMicrosoft365 client library for JavaScript
2-
3-
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure AppComplianceAutomationToolForMicrosoft365 client.
1+
# Azure AppComplianceAutomation REST client library for JavaScript
42

53
App Compliance Automation Tool for Microsoft 365 API spec
64

7-
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appcomplianceautomation/arm-appcomplianceautomation) |
8-
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-appcomplianceautomation) |
9-
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-appcomplianceautomation) |
10-
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
5+
**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
6+
7+
Key links:
8+
9+
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-appcomplianceautomation)
10+
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-appcomplianceautomation?view=azure-node-preview)
1111

1212
## Getting started
1313

1414
### Currently supported environments
1515

16-
- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
17-
- Latest versions of Safari, Chrome, Edge and Firefox.
18-
19-
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
16+
- LTS versions of Node.js
2017

2118
### Prerequisites
2219

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

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

27-
Install the Azure AppComplianceAutomationToolForMicrosoft365 client library for JavaScript with `npm`:
24+
Install the Azure AppComplianceAutomation REST client REST client library for JavaScript with `npm`:
2825

2926
```bash
3027
npm install @azure/arm-appcomplianceautomation
3128
```
3229

33-
### Create and authenticate a `AppComplianceAutomationToolForMicrosoft365`
30+
### Create and authenticate a `AppComplianceAutomationClient`
3431

35-
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.
36-
You can find the endpoint for your Azure AppComplianceAutomationToolForMicrosoft365 resource in the [Azure Portal][azure_portal].
32+
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),
33+
provide an instance of the desired credential type obtained from the
34+
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
3735

38-
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).
39-
40-
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
41-
42-
```bash
43-
npm install @azure/identity
44-
```
45-
46-
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).
47-
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`.
48-
49-
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).
50-
51-
```javascript
52-
const { AppComplianceAutomationToolForMicrosoft365 } = require("@azure/arm-appcomplianceautomation");
53-
const { DefaultAzureCredential } = require("@azure/identity");
54-
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
55-
56-
const client = new AppComplianceAutomationToolForMicrosoft365(new DefaultAzureCredential());
57-
58-
// For client-side applications running in the browser, use this code instead:
59-
// const credential = new InteractiveBrowserCredential({
60-
// tenantId: "<YOUR_TENANT_ID>",
61-
// clientId: "<YOUR_CLIENT_ID>"
62-
// });
63-
// const client = new AppComplianceAutomationToolForMicrosoft365(credential);
64-
```
36+
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
6537

38+
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.
39+
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
40+
can be used to authenticate the client.
6641

67-
### JavaScript Bundle
68-
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).
69-
70-
## Key concepts
71-
72-
### AppComplianceAutomationToolForMicrosoft365
73-
74-
`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.
42+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
43+
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
7544

7645
## Troubleshooting
7746

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

8251
```javascript
8352
const { setLogLevel } = require("@azure/logger");
53+
8454
setLogLevel("info");
8555
```
8656

8757
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).
88-
89-
## Next steps
90-
91-
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.
92-
93-
## Contributing
94-
95-
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.
96-
97-
## Related projects
98-
99-
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
100-
101-
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fappcomplianceautomation%2Farm-appcomplianceautomation%2FREADME.png)
102-
103-
[azure_cli]: https://docs.microsoft.com/cli/azure
104-
[azure_sub]: https://azure.microsoft.com/free/
105-
[azure_sub]: https://azure.microsoft.com/free/
106-
[azure_portal]: https://portal.azure.com
107-
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
108-
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

sdk/appcomplianceautomation/arm-appcomplianceautomation/_meta.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

sdk/appcomplianceautomation/arm-appcomplianceautomation/api-extractor.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
3+
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
44
"docModel": {
55
"enabled": true
66
},

sdk/appcomplianceautomation/arm-appcomplianceautomation/assets.json

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";
2+
3+
export default [
4+
...azsdkEslint.configs.recommended,
5+
{
6+
rules: {
7+
"@azure/azure-sdk/ts-modules-only-named": "warn",
8+
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
9+
"@azure/azure-sdk/ts-package-json-types": "warn",
10+
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
11+
"@azure/azure-sdk/ts-package-json-module": "off",
12+
"@azure/azure-sdk/ts-package-json-files-required": "off",
13+
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
14+
"tsdoc/syntax": "warn"
15+
}
16+
}
17+
];

0 commit comments

Comments
 (0)