forked from Azure/azure-sdk-for-js
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 17000 in Azure/azure-rest-api-specs
[Go] Track2 modify readme.go.md 9 (Azure#17000) * [Go] Track2 modify readme.go.md 9 * fix
- Loading branch information
SDKAuto
committed
Jan 5, 2022
1 parent
dbbce26
commit 1210f86
Showing
37 changed files
with
3,248 additions
and
2,416 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Release History | ||
|
|
||
| ## 2.0.0 (2022-01-05) | ||
|
|
||
| The package of @azure/arm-support is using our next generation design principles since version 2.0.0, which contains breaking changes. | ||
|
|
||
| To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog). | ||
|
|
||
| To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide). | ||
|
|
||
| To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2022 Microsoft | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +1,98 @@ | ||
| ## Azure MicrosoftSupport SDK for JavaScript | ||
| # Azure Service client library for JavaScript | ||
|
|
||
| This package contains an isomorphic SDK for MicrosoftSupport. | ||
| This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client. | ||
|
|
||
| Microsoft Azure Support Resource Provider. | ||
|
|
||
| [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/support/arm-support) | | ||
| [Package (NPM)](https://www.npmjs.com/package/@azure/arm-support) | | ||
| [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-support) | | ||
| [Samples](https://github.com/Azure-Samples/azure-samples-js-management) | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Currently supported environments | ||
|
|
||
| - [LTS versions of Node.js](https://nodejs.org/about/releases/) | ||
| - Latest versions of Safari, Chrome, Edge, and Firefox. | ||
| - Latest versions of Safari, Chrome, Edge and Firefox. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - An [Azure subscription][azure_sub]. | ||
|
|
||
| ### Install the `@azure/arm-support` package | ||
|
|
||
| ### How to Install | ||
| Install the Azure Service client library for JavaScript with `npm`: | ||
|
|
||
| ```bash | ||
| npm install @azure/arm-support | ||
| ``` | ||
|
|
||
| ### How to use | ||
| ### Create and authenticate a `MicrosoftSupport` | ||
|
|
||
| #### nodejs - Authentication, client creation and list operations as an example written in TypeScript. | ||
| To create a client object to access the Azure Service API, you will need the `endpoint` of your Azure Service resource and a `credential`. The Azure Service client can use Azure Active Directory credentials to authenticate. | ||
| You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal]. | ||
|
|
||
| ##### Install @azure/ms-rest-nodeauth | ||
| 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: | ||
|
|
||
| - Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`. | ||
| ```bash | ||
| npm install @azure/ms-rest-nodeauth@"^3.0.0" | ||
| npm install @azure/identity | ||
| ``` | ||
|
|
||
| ##### Sample code | ||
|
|
||
| ```typescript | ||
| import * as msRest from "@azure/ms-rest-js"; | ||
| import * as msRestAzure from "@azure/ms-rest-azure-js"; | ||
| import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; | ||
| import { MicrosoftSupport, MicrosoftSupportModels, MicrosoftSupportMappers } from "@azure/arm-support"; | ||
| const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; | ||
|
|
||
| msRestNodeAuth.interactiveLogin().then((creds) => { | ||
| const client = new MicrosoftSupport(creds, subscriptionId); | ||
| client.operations.list().then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }); | ||
| }).catch((err) => { | ||
| console.error(err); | ||
| }); | ||
| You will also need to **register a new AAD application and grant access to Azure Service** 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 { MicrosoftSupport } = require("@azure/arm-support"); | ||
| const { DefaultAzureCredential } = require("@azure/identity"); | ||
| const subscriptionId = "00000000-0000-0000-0000-000000000000"; | ||
| const client = new MicrosoftSupport(new DefaultAzureCredential(), subscriptionId); | ||
| ``` | ||
|
|
||
| #### browser - Authentication, client creation and list operations as an example written in JavaScript. | ||
|
|
||
| ##### Install @azure/ms-rest-browserauth | ||
| ### 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). | ||
|
|
||
| ```bash | ||
| npm install @azure/ms-rest-browserauth | ||
| ``` | ||
| ## Key concepts | ||
|
|
||
| ##### Sample code | ||
|
|
||
| See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. | ||
|
|
||
| - index.html | ||
| ```html | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>@azure/arm-support sample</title> | ||
| <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script> | ||
| <script src="node_modules/@azure/arm-support/dist/arm-support.js"></script> | ||
| <script type="text/javascript"> | ||
| const subscriptionId = "<Subscription_Id>"; | ||
| const authManager = new msAuth.AuthManager({ | ||
| clientId: "<client id for your Azure AD app>", | ||
| tenant: "<optional tenant for your organization>" | ||
| }); | ||
| authManager.finalizeLogin().then((res) => { | ||
| if (!res.isLoggedIn) { | ||
| // may cause redirects | ||
| authManager.login(); | ||
| } | ||
| const client = new Azure.ArmSupport.MicrosoftSupport(res.creds, subscriptionId); | ||
| client.operations.list().then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }).catch((err) => { | ||
| console.log("An error occurred:"); | ||
| console.error(err); | ||
| }); | ||
| }); | ||
| </script> | ||
| </head> | ||
| <body></body> | ||
| </html> | ||
| ### MicrosoftSupport | ||
|
|
||
| `MicrosoftSupport` is the primary interface for developers using the Azure Service client library. Explore the methods on this client object to understand the different features of the Azure Service service that you can access. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Logging | ||
|
|
||
| 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`: | ||
|
|
||
| ```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) | ||
| - [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js) | ||
|
|
||
|  | ||
|
|
||
|  | ||
| [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 contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "commit": "2ab4371edba33c23e8d680ed2bf6f98705b5cadb", | ||
| "readme": "specification/support/resource-manager/readme.md", | ||
| "autorest_command": "autorest --version=3.1.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/support/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20211130.1", | ||
| "repository_url": "https://github.com/Azure/azure-rest-api-specs.git", | ||
| "use": "@autorest/typescript@6.0.0-alpha.16.20211130.1" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +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" }, | ||
| "dtsRollup": { | ||
| "enabled": true, | ||
| "untrimmedFilePath": "", | ||
| "publicTrimmedFilePath": "./types/arm-support.d.ts" | ||
| }, | ||
| "messages": { | ||
| "tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
| "extractorMessageReporting": { | ||
| "ae-missing-release-tag": { "logLevel": "none" }, | ||
| "ae-unresolved-link": { "logLevel": "none" } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.