Skip to content

Commit 874b8b1

Browse files
author
SDKAuto
committed
CodeGen from PR 21452 in Azure/azure-rest-api-specs
Merge fe8518a30954942a6f94747f0a2ef7a9b9f58338 into 894645e485d2f01e83999480d440e1bace3fec9b
1 parent 2567ec7 commit 874b8b1

Some content is hidden

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

60 files changed

+19678
-5
lines changed

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

+32-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rush.json

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* This is the main configuration file for Rush.
33
* For full documentation, please see https://rushjs.io
4-
*/ {
4+
*/{
55
"$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json",
66
/**
77
* (Required) This specifies the version of the Rush engine to be used in this repo.
@@ -1935,6 +1935,11 @@
19351935
"packageName": "@azure/arm-hybridcontainerservice",
19361936
"projectFolder": "sdk/hybridcontainerservice/arm-hybridcontainerservice",
19371937
"versionPolicyName": "management"
1938+
},
1939+
{
1940+
"packageName": "@azure/arm-dataprotectionplatform",
1941+
"projectFolder": "sdk/dataprotectionplatform/arm-dataprotectionplatform",
1942+
"versionPolicyName": "management"
19381943
}
19391944
]
1940-
}
1945+
}

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

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

‎sdk/dataprotectionplatform/arm-dataprotectionplatform/LICENSE

+21
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/dataprotectionplatform/arm-dataprotectionplatform/README.md

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Azure Data Protection client library for JavaScript
2+
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Data Protection client.
4+
5+
Open API 2.0 Specs for Azure Data Protection service
6+
7+
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/dataprotectionplatform/arm-dataprotectionplatform) |
8+
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-dataprotectionplatform) |
9+
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-dataprotectionplatform?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://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.
20+
21+
### Prerequisites
22+
23+
- An [Azure subscription][azure_sub].
24+
25+
### Install the `@azure/arm-dataprotectionplatform` package
26+
27+
Install the Azure Data Protection client library for JavaScript with `npm`:
28+
29+
```bash
30+
npm install @azure/arm-dataprotectionplatform
31+
```
32+
33+
### Create and authenticate a `DataProtectionClient`
34+
35+
To create a client object to access the Azure Data Protection API, you will need the `endpoint` of your Azure Data Protection resource and a `credential`. The Azure Data Protection client can use Azure Active Directory credentials to authenticate.
36+
You can find the endpoint for your Azure Data Protection resource in the [Azure Portal][azure_portal].
37+
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 Data Protection** 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 { DataProtectionClient } = require("@azure/arm-dataprotectionplatform");
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 subscriptionId = "00000000-0000-0000-0000-000000000000";
57+
const client = new DataProtectionClient(new DefaultAzureCredential(), subscriptionId);
58+
59+
// For client-side applications running in the browser, use this code instead:
60+
// const credential = new InteractiveBrowserCredential({
61+
// tenantId: "<YOUR_TENANT_ID>",
62+
// clientId: "<YOUR_CLIENT_ID>"
63+
// });
64+
// const client = new DataProtectionClient(credential, subscriptionId);
65+
```
66+
67+
68+
### JavaScript Bundle
69+
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).
70+
71+
## Key concepts
72+
73+
### DataProtectionClient
74+
75+
`DataProtectionClient` is the primary interface for developers using the Azure Data Protection client library. Explore the methods on this client object to understand the different features of the Azure Data Protection service that you can access.
76+
77+
## Troubleshooting
78+
79+
### Logging
80+
81+
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`:
82+
83+
```javascript
84+
const { setLogLevel } = require("@azure/logger");
85+
setLogLevel("info");
86+
```
87+
88+
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).
89+
90+
## Next steps
91+
92+
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.
93+
94+
## Contributing
95+
96+
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.
97+
98+
## Related projects
99+
100+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
101+
102+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fdataprotectionplatform%2Farm-dataprotectionplatform%2FREADME.png)
103+
104+
[azure_cli]: https://docs.microsoft.com/cli/azure
105+
[azure_sub]: https://azure.microsoft.com/free/
106+
[azure_sub]: https://azure.microsoft.com/free/
107+
[azure_portal]: https://portal.azure.com
108+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
109+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

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

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"commit": "72edf7daefd4cec94ab77ee5b4329917e32c8cea",
3+
"readme": "specification/dataprotection/resource-manager/readme.md",
4+
"autorest_command": "autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/dataprotection/resource-manager/readme.md --use=@autorest/[email protected]",
5+
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6+
"release_tool": "@azure-tools/[email protected]",
7+
"use": "@autorest/[email protected]"
8+
}

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

+31
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-dataprotectionplatform.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/dataprotectionplatform/arm-dataprotectionplatform/package.json

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
{
2+
"name": "@azure/arm-dataprotectionplatform",
3+
"sdk-type": "mgmt",
4+
"author": "Microsoft Corporation",
5+
"description": "A generated SDK for DataProtectionClient.",
6+
"version": "1.0.0-beta.1",
7+
"engines": {
8+
"node": ">=14.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.5.0",
15+
"@azure/core-auth": "^1.3.0",
16+
"@azure/core-rest-pipeline": "^1.8.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-dataprotectionplatform.d.ts",
30+
"devDependencies": {
31+
"@microsoft/api-extractor": "^7.31.1",
32+
"@rollup/plugin-commonjs": "^21.0.1",
33+
"@rollup/plugin-json": "^4.1.0",
34+
"@rollup/plugin-multi-entry": "^4.1.0",
35+
"@rollup/plugin-node-resolve": "^13.1.3",
36+
"mkdirp": "^1.0.4",
37+
"rollup": "^2.66.1",
38+
"rollup-plugin-sourcemaps": "^0.6.3",
39+
"typescript": "~4.6.0",
40+
"uglify-js": "^3.4.9",
41+
"rimraf": "^3.0.0",
42+
"@azure/identity": "^2.0.1",
43+
"@azure-tools/test-recorder": "^2.0.0",
44+
"@azure-tools/test-credential": "^1.0.0",
45+
"mocha": "^7.1.1",
46+
"@types/chai": "^4.2.8",
47+
"chai": "^4.2.0",
48+
"cross-env": "^7.0.2",
49+
"@azure/dev-tool": "^1.0.0"
50+
},
51+
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/dataprotectionplatform/arm-dataprotectionplatform",
52+
"repository": {
53+
"type": "git",
54+
"url": "https://github.com/Azure/azure-sdk-for-js.git"
55+
},
56+
"bugs": {
57+
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
58+
},
59+
"files": [
60+
"dist/**/*.js",
61+
"dist/**/*.js.map",
62+
"dist/**/*.d.ts",
63+
"dist/**/*.d.ts.map",
64+
"dist-esm/**/*.js",
65+
"dist-esm/**/*.js.map",
66+
"dist-esm/**/*.d.ts",
67+
"dist-esm/**/*.d.ts.map",
68+
"src/**/*.ts",
69+
"README.md",
70+
"LICENSE",
71+
"rollup.config.js",
72+
"tsconfig.json",
73+
"review/*",
74+
"CHANGELOG.md",
75+
"types/*"
76+
],
77+
"scripts": {
78+
"build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
79+
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
80+
"prepack": "npm run build",
81+
"pack": "npm pack 2>&1",
82+
"extract-api": "api-extractor run --local",
83+
"lint": "echo skipped",
84+
"audit": "echo skipped",
85+
"clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
86+
"build:node": "echo skipped",
87+
"build:browser": "echo skipped",
88+
"build:test": "echo skipped",
89+
"build:samples": "echo skipped.",
90+
"check-format": "echo skipped",
91+
"execute:samples": "echo skipped",
92+
"format": "echo skipped",
93+
"test": "npm run integration-test",
94+
"test:node": "echo skipped",
95+
"test:browser": "echo skipped",
96+
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
97+
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
98+
"unit-test:browser": "echo skipped",
99+
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
100+
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
101+
"integration-test:browser": "echo skipped"
102+
},
103+
"sideEffects": false,
104+
"//metadata": {
105+
"constantPaths": [
106+
{
107+
"path": "src/dataProtectionClient.ts",
108+
"prefix": "packageDetails"
109+
}
110+
]
111+
},
112+
"autoPublish": true
113+
}

0 commit comments

Comments
 (0)