Skip to content

Commit 06aea7f

Browse files
author
SDKAuto
committed
CodeGen from PR 17667 in Azure/azure-rest-api-specs
Merge 7a6f63393a3d70a61ee2253e62ec2b4e3866a52f into 18a4efa19a1e7c3709397b6ff33c69b63e4927a8
1 parent 2d47bff commit 06aea7f

File tree

25 files changed

+3089
-3
lines changed

25 files changed

+3089
-3
lines changed

‎common/config/rush/pnpm-lock.yaml‎

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

‎rush.json‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1574,6 +1574,11 @@
15741574
"packageName": "@azure/core-http-compat",
15751575
"projectFolder": "sdk/core/core-http-compat",
15761576
"versionPolicyName": "core"
1577+
},
1578+
{
1579+
"packageName": "@azure/arm-dashboard",
1580+
"projectFolder": "sdk/dashboard/arm-dashboard",
1581+
"versionPolicyName": "management"
15771582
}
15781583
]
1579-
}
1584+
}

‎sdk/dashboard/arm-dashboard/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2022-02-17)
4+
5+
The package of @azure/arm-dashboard is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart).

‎sdk/dashboard/arm-dashboard/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2022 Microsoft
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎sdk/dashboard/arm-dashboard/README.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Azure DashboardManagement client library for JavaScript
2+
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure DashboardManagement client.
4+
5+
The Microsoft.Dashboard Rest API spec.
6+
7+
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/dashboard/arm-dashboard) |
8+
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-dashboard) |
9+
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-dashboard?view=azure-node-preview) |
10+
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
11+
12+
## Getting started
13+
14+
### Currently supported environments
15+
16+
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
17+
- Latest versions of Safari, Chrome, Edge and Firefox.
18+
19+
### Prerequisites
20+
21+
- An [Azure subscription][azure_sub].
22+
23+
### Install the `@azure/arm-dashboard` package
24+
25+
Install the Azure DashboardManagement client library for JavaScript with `npm`:
26+
27+
```bash
28+
npm install @azure/arm-dashboard
29+
```
30+
31+
### Create and authenticate a `DashboardManagementClient`
32+
33+
To create a client object to access the Azure DashboardManagement API, you will need the `endpoint` of your Azure DashboardManagement resource and a `credential`. The Azure DashboardManagement client can use Azure Active Directory credentials to authenticate.
34+
You can find the endpoint for your Azure DashboardManagement resource in the [Azure Portal][azure_portal].
35+
36+
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).
37+
38+
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
39+
40+
```bash
41+
npm install @azure/identity
42+
```
43+
44+
You will also need to **register a new AAD application and grant access to Azure DashboardManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
45+
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`.
46+
47+
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).
48+
49+
```javascript
50+
const { DashboardManagementClient } = require("@azure/arm-dashboard");
51+
const { DefaultAzureCredential } = require("@azure/identity");
52+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
53+
const client = new DashboardManagementClient(new DefaultAzureCredential(), subscriptionId);
54+
```
55+
56+
57+
### JavaScript Bundle
58+
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).
59+
60+
## Key concepts
61+
62+
### DashboardManagementClient
63+
64+
`DashboardManagementClient` is the primary interface for developers using the Azure DashboardManagement client library. Explore the methods on this client object to understand the different features of the Azure DashboardManagement service that you can access.
65+
66+
## Troubleshooting
67+
68+
### Logging
69+
70+
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
71+
72+
```javascript
73+
const { setLogLevel } = require("@azure/logger");
74+
setLogLevel("info");
75+
```
76+
77+
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).
78+
79+
## Next steps
80+
81+
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.
82+
83+
## Contributing
84+
85+
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.
86+
87+
## Related projects
88+
89+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
90+
91+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fdashboard%2Farm-dashboard%2FREADME.png)
92+
93+
[azure_cli]: https://docs.microsoft.com/cli/azure
94+
[azure_sub]: https://azure.microsoft.com/free/
95+
[azure_sub]: https://azure.microsoft.com/free/
96+
[azure_portal]: https://portal.azure.com
97+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
98+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

‎sdk/dashboard/arm-dashboard/_meta.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"commit": "8eff0b585215c1e223cc32949f595decf73514cc",
3+
"readme": "specification/dashboard/resource-manager/readme.md",
4+
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/dashboard/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20220105.1",
5+
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6+
"use": "@autorest/typescript@6.0.0-alpha.16.20220105.1"
7+
}

‎sdk/dashboard/arm-dashboard/api-extractor.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
4+
"docModel": {
5+
"enabled": true
6+
},
7+
"apiReport": {
8+
"enabled": true,
9+
"reportFolder": "./review"
10+
},
11+
"dtsRollup": {
12+
"enabled": true,
13+
"untrimmedFilePath": "",
14+
"publicTrimmedFilePath": "./types/arm-dashboard.d.ts"
15+
},
16+
"messages": {
17+
"tsdocMessageReporting": {
18+
"default": {
19+
"logLevel": "none"
20+
}
21+
},
22+
"extractorMessageReporting": {
23+
"ae-missing-release-tag": {
24+
"logLevel": "none"
25+
},
26+
"ae-unresolved-link": {
27+
"logLevel": "none"
28+
}
29+
}
30+
}
31+
}

‎sdk/dashboard/arm-dashboard/package.json‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
{
2+
"name": "@azure/arm-dashboard",
3+
"sdk-type": "mgmt",
4+
"author": "Microsoft Corporation",
5+
"description": "A generated SDK for DashboardManagementClient.",
6+
"version": "1.0.0-beta.1",
7+
"engines": {
8+
"node": ">=12.0.0"
9+
},
10+
"dependencies": {
11+
"@azure/core-lro": "^2.2.0",
12+
"@azure/abort-controller": "^1.0.0",
13+
"@azure/core-paging": "^1.2.0",
14+
"@azure/core-client": "^1.0.0",
15+
"@azure/core-auth": "^1.3.0",
16+
"@azure/core-rest-pipeline": "^1.1.0",
17+
"tslib": "^2.2.0"
18+
},
19+
"keywords": [
20+
"node",
21+
"azure",
22+
"typescript",
23+
"browser",
24+
"isomorphic"
25+
],
26+
"license": "MIT",
27+
"main": "./dist/index.js",
28+
"module": "./dist-esm/src/index.js",
29+
"types": "./types/arm-dashboard.d.ts",
30+
"devDependencies": {
31+
"@microsoft/api-extractor": "^7.18.11",
32+
"@rollup/plugin-commonjs": "11.0.2",
33+
"@rollup/plugin-json": "^4.0.0",
34+
"@rollup/plugin-multi-entry": "^3.0.0",
35+
"@rollup/plugin-node-resolve": "^8.0.0",
36+
"mkdirp": "^1.0.4",
37+
"rollup": "^1.16.3",
38+
"rollup-plugin-sourcemaps": "^0.4.2",
39+
"typescript": "~4.2.0",
40+
"uglify-js": "^3.4.9",
41+
"rimraf": "^3.0.0",
42+
"@azure/identity": "^2.0.1",
43+
"@azure-tools/test-recorder": "^1.0.0",
44+
"mocha": "^7.1.1",
45+
"cross-env": "^7.0.2"
46+
},
47+
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/dashboard/arm-dashboard",
48+
"repository": {
49+
"type": "git",
50+
"url": "https://github.com/Azure/azure-sdk-for-js.git"
51+
},
52+
"bugs": {
53+
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
54+
},
55+
"files": [
56+
"dist/**/*.js",
57+
"dist/**/*.js.map",
58+
"dist/**/*.d.ts",
59+
"dist/**/*.d.ts.map",
60+
"dist-esm/**/*.js",
61+
"dist-esm/**/*.js.map",
62+
"dist-esm/**/*.d.ts",
63+
"dist-esm/**/*.d.ts.map",
64+
"src/**/*.ts",
65+
"README.md",
66+
"LICENSE",
67+
"rollup.config.js",
68+
"tsconfig.json",
69+
"review/*",
70+
"CHANGELOG.md",
71+
"types/*"
72+
],
73+
"scripts": {
74+
"build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
75+
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
76+
"prepack": "npm run build",
77+
"pack": "npm pack 2>&1",
78+
"extract-api": "api-extractor run --local",
79+
"lint": "echo skipped",
80+
"audit": "echo skipped",
81+
"clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
82+
"build:node": "echo skipped",
83+
"build:browser": "echo skipped",
84+
"build:test": "echo skipped",
85+
"build:samples": "echo skipped.",
86+
"check-format": "echo skipped",
87+
"execute:samples": "echo skipped",
88+
"format": "echo skipped",
89+
"test": "npm run integration-test",
90+
"test:node": "echo skipped",
91+
"test:browser": "echo skipped",
92+
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
93+
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
94+
"unit-test:browser": "echo skipped",
95+
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
96+
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
97+
"integration-test:browser": "echo skipped",
98+
"docs": "echo skipped"
99+
},
100+
"sideEffects": false,
101+
"autoPublish": true
102+
}

0 commit comments

Comments
 (0)