From 854d257785892ad65008380b465609282b95f19f Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 21:49:38 +0800 Subject: [PATCH 01/20] Update compute readme --- .../Azure.ResourceManager.Compute/README.md | 82 ++++++++----------- 1 file changed, 32 insertions(+), 50 deletions(-) diff --git a/sdk/compute/Azure.ResourceManager.Compute/README.md b/sdk/compute/Azure.ResourceManager.Compute/README.md index 87028f10e725..7268f766c003 100644 --- a/sdk/compute/Azure.ResourceManager.Compute/README.md +++ b/sdk/compute/Azure.ResourceManager.Compute/README.md @@ -1,69 +1,51 @@ -# README.md template - -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - # Azure Management Compute client library for .NET -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) +Install the Azure Management Compute client library for .NET with [NuGet](https://www.nuget.org/): -### Authenticate the client +```PowerShell +Install-Package Azure.ResourceManager.Compute +``` -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +## Documentation -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +Various documentation is available to help you learn how to use this package -## Key concepts +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +## Need help? -## Examples - -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fcompute%2FAzure.ResourceManager.Compute%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From 7d274d4cc7cc8f857160df92aad7b06b25be8574 Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:06:32 +0800 Subject: [PATCH 02/20] Update resources --- .../Azure.ResourceManager.Resources/README.md | 84 ++++++++----------- 1 file changed, 33 insertions(+), 51 deletions(-) diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index 3c76339b7b52..ba35d10fc956 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -1,69 +1,51 @@ -# README.md template +# Azure Management Compute client library for .NET -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - -# Azure Management Resource client library for .NET - -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) +Install the Azure Management Compute client library for .NET with [NuGet](https://www.nuget.org/): -### Authenticate the client +```PowerShell +Install-Package Azure.ResourceManager.Resources +``` -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +## Documentation -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +Various documentation is available to help you learn how to use this package -## Key concepts +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +## Need help? -## Examples - -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From dc756424817db1423d29f1bd082c5c0bcd10632a Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:08:08 +0800 Subject: [PATCH 03/20] Update storage readme --- .../Azure.ResourceManager.Storage/README.md | 83 +++++++------------ 1 file changed, 32 insertions(+), 51 deletions(-) diff --git a/sdk/storage/Azure.ResourceManager.Storage/README.md b/sdk/storage/Azure.ResourceManager.Storage/README.md index debbc22408f2..1d6ced4db471 100644 --- a/sdk/storage/Azure.ResourceManager.Storage/README.md +++ b/sdk/storage/Azure.ResourceManager.Storage/README.md @@ -1,70 +1,51 @@ -# README.md template - -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - # Azure Management Storage client library for .NET -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) - -### Authenticate the client +Install the Azure Management Storage client library for .NET with [NuGet](https://www.nuget.org/): -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +```PowerShell +Install-Package Azure.ResourceManager.Storage +``` -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +## Documentation -## Key concepts +Various documentation is available to help you learn how to use this package -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Examples +## Need help? -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. - - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From f80f0cdcd00eadba9151be1548476b06bbcc6f10 Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:10:07 +0800 Subject: [PATCH 04/20] Update resources readme --- sdk/resources/Azure.ResourceManager.Resources/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index ba35d10fc956..e0aeb687136d 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -1,4 +1,4 @@ -# Azure Management Compute client library for .NET +# Azure Management Resources client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,7 +8,7 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management Compute client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Management Resources client library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell Install-Package Azure.ResourceManager.Resources From 419c3cc99b512dedba7565dd7d3a01d2c59dc2ee Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:11:05 +0800 Subject: [PATCH 05/20] Update network --- .../Azure.ResourceManager.Network/README.md | 90 +++++++------------ 1 file changed, 32 insertions(+), 58 deletions(-) diff --git a/sdk/network/Azure.ResourceManager.Network/README.md b/sdk/network/Azure.ResourceManager.Network/README.md index 08f8195841f1..087174d34dcc 100644 --- a/sdk/network/Azure.ResourceManager.Network/README.md +++ b/sdk/network/Azure.ResourceManager.Network/README.md @@ -1,77 +1,51 @@ -# README.md template - -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - # Azure Management Network client library for .NET -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) - -### Authenticate the client - -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +Install the Azure Management Network client library for .NET with [NuGet](https://www.nuget.org/): -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +```PowerShell +Install-Package Azure.ResourceManager.Network +``` -## Key concepts +## Documentation -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +Various documentation is available to help you learn how to use this package -## Examples +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. +## Need help? -If possible, use the same example snippets that your in-code documentation uses. For example, use the snippets in your `examples.py` that Sphinx ingests via its [literalinclude](https://www.sphinx-doc.org/en/1.5/markup/code.html?highlight=code%20examples#includes) directive. The `examples.py` file containing the snippets should reside alongside your package's code, and should be tested in an automated fashion. - -Each example in the *Examples* section starts with an H3 that describes the example. At the top of this section, just under the *Examples* H2, add a bulleted list linking to each example H3. Each example should deep-link to the types and/or members used in the example. - -* [Create the thing](#create-the-thing) -* [Get the thing](#get-the-thing) -* [List the things](#list-the-things) - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fnetwork%2FAzure.ResourceManager.Network%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From 1e70c275b72800af62217bc6f6fe2719d76bc78c Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:12:08 +0800 Subject: [PATCH 06/20] Update event hubs --- .../Azure.ResourceManager.EventHubs/README.md | 84 ++++++++----------- 1 file changed, 33 insertions(+), 51 deletions(-) diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index 9dfec6e4102c..c924a842ab58 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -1,69 +1,51 @@ -# README.md template +# Azure Management EventHubs client library for .NET -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - -# Azure Management EventHub client library for .NET - -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) +Install the Azure Management EventHubs client library for .NET with [NuGet](https://www.nuget.org/): -### Authenticate the client +```PowerShell +Install-Package Azure.ResourceManager.EventHubs +``` -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +## Documentation -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +Various documentation is available to help you learn how to use this package -## Key concepts +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +## Need help? -## Examples - -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From 162c586bb6b33fe9b68115d86d52c238799f3b8c Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:13:34 +0800 Subject: [PATCH 07/20] Update app configuration --- .../README.md | 83 +++++++------------ 1 file changed, 32 insertions(+), 51 deletions(-) diff --git a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md index 5cd4c6261230..f54eb77bd68e 100644 --- a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md +++ b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md @@ -1,70 +1,51 @@ -# README.md template - -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - # Azure Management AppConfiguration client library for .NET -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) +Install the Azure Management App Configuration client library for .NET with [NuGet](https://www.nuget.org/): -### Authenticate the client +```PowerShell +Install-Package Azure.ResourceManager.AppConfiguration +``` -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +## Documentation -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +Various documentation is available to help you learn how to use this package -## Key concepts +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +## Need help? -## Examples - -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From c216bafa29974240e8b5c4a5eb9f3caaf28e1f8b Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:15:29 +0800 Subject: [PATCH 08/20] Update key vault readme --- .../Azure.ResourceManager.KeyVault/README.md | 82 ++++++++----------- 1 file changed, 32 insertions(+), 50 deletions(-) diff --git a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md index 5c2635a1adb5..3edf0c013bf4 100644 --- a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md +++ b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md @@ -1,69 +1,51 @@ -# README.md template - -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. - -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. -* Example: `# Azure Batch client library for Python` - # Azure Management KeyVault client library for .NET -**Introduction**: The introduction appears directly under the title (H1) of your README. - -* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. -* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). -* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. -* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): - - [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) - -> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. +This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. ## Getting started -This section should include everything a developer needs to do to install and create their first client connection *very quickly*. +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) ### Install the package -First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. - -### Prerequisites - -* You must have an [Azure subscription](https://azure.microsoft.com/free/) +Install the Azure Management KeyVault client library for .NET with [NuGet](https://www.nuget.org/): -### Authenticate the client +```PowerShell +Install-Package Azure.ResourceManager.KeyVault +``` -If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. +## Documentation -For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. +Various documentation is available to help you learn how to use this package -## Key concepts +- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) +- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. +## Need help? -## Examples - -Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations. - -## Troubleshooting - -Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. - -Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. - -If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. - -## Next steps - -* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. -* If appropriate, point users to other packages that might be useful. -* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. ## Contributing -This is a template, but your SDK readme should include details on how to contribute code to the repo/package. +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . - -[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From 6f382aa0eefe93a865f92d5291cf24fd771528bc Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:20:41 +0800 Subject: [PATCH 09/20] Create mgmt preview quickstart --- doc/mgmt_preview_quickstart.md | 338 +++++++++++++++++++++++++++++++++ 1 file changed, 338 insertions(+) create mode 100644 doc/mgmt_preview_quickstart.md diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md new file mode 100644 index 000000000000..4f25baa425ca --- /dev/null +++ b/doc/mgmt_preview_quickstart.md @@ -0,0 +1,338 @@ + +Quickstart Tutorial - Resource Management (Preview Libraries) +============================================================= + +We are excited to announce that a new set of management libraries are +now in Public Preview. Those packages share a number of new features +such as Azure Identity support, HTTP pipeline, error-handling.,etc, and +they also follow the new Azure SDK guidelines which create easy-to-use +APIs that are idiomatic, compatible, and dependable. + +You can find the details of those new libraries +[here](https://azure.github.io/azure-sdk/releases/latest/#dotnet) + +In this basic quickstart guide, we will walk you through how to +authenticate to Azure using the preview libraries and start interacting +with Azure resources. There are several possible approaches to +authentication. This document illustrates the most common scenario + +Prerequisites +------------- + +You will need the following values to authenticate to Azure + +- **Subscription ID** +- **Client ID** +- **Client Secret** +- **Tenant ID** + +These values can be obtained from the portal, here's the instructions: + +### Get Subscription ID + +1. Login into your Azure account +2. Select Subscriptions in the left sidebar +3. Select whichever subscription is needed +4. Click on Overview +5. Copy the Subscription ID + +### Get Client ID / Client Secret / Tenant ID + +For information on how to get Client ID, Client Secret, and Tenant ID, +please refer to [this +document](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal) + +### Setting Environment Variables + +After you obtained the values, you need to set the following values as +your environment variables + +- `AZURE_CLIENT_ID` +- `AZURE_CLIENT_SECRET` +- `AZURE_TENANT_ID` +- `AZURE_SUBSCRIPTION_ID` + +To set the following environment variables on your development system: + +Windows (Note: Administrator access is required) + +1. Open the Control Panel +2. Click System Security, then System +3. Click Advanced system settings on the left +4. Inside the System Properties window, click the Environment + Variables… button. +5. Click on the property you would like to change, then click the Edit… + button. If the property name is not listed, then click the New… + button. + +Linux-based OS : + + export AZURE_CLIENT_ID="__CLIENT_ID__" + export AZURE_CLIENT_SECRET="__CLIENT_SECRET__" + export AZURE_TENANT_ID="__TENANT_ID__" + export AZURE_SUBSCRIPTION_ID="__SUBSCRIPTION_ID__" + +Authentication and Creating Resource Management Client +------------------------------------------------------ + +Now that the environment is setup, all you need to do is to create an +authenticated client. Our default option is to use +**DefaultAzureCredential** and in this guide we have picked +**Resources** as our target service, but you can set it up similarly for +any other service that you are using. + +To authenticate to Azure and create a management client, simply do the +following: +```csharp + using Azure.Identity; + using Azure.ResourceManager.Resources; + using Azure.ResourceManager.Resources.Models; + using System; + ... + var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); + var resourceClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); + var resourceGroupsClient = resourceClient.GetResourceGroupsClient(); +``` +From this code snippet, we showed that in order to interact with Resources, we need to create a top-level client first (**ResourcesManagementClient**), then get the corresponding sub-resource client we are interested in, in this case we called **.GetResourceGroupsClient()** to get a ResourceGroupsClient + +For more information and different authentication approaches using Azure +Identity can be found in [this document](https://docs.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet) + +Interacting with Azure Resources +-------------------------------- + +Now that we are authenticated, we can use our management client to make API calls. Let's demonstrate management client's usage by showing concrete examples + +Example: Managing Resource Groups +--------------------------------- +We can use the Resource client (``Azure.ResourceManager.Resources.ResourcesManagementClient``) we have created to perform operations on Resource Group. In this example, we will show to manage Resource Groups. + +***Create a resource group*** + +```csharp + var location = "westus2"; + var resourceGroupName = "myResourceGroupName"; + var resourceGroup = new ResourceGroup(location); + resourceGroup = await resourceGroupsClient.CreateOrUpdateAsync(resourceGroupName, resourceGroup); +``` + +***Update a resource group*** + +```csharp + ... + var newResourceGroup = new ResourceGroup(location); + var resourceGroupName = "myResourceGroupName"; + var tags = new Dictionary(); + tags.Add("environment","test"); + tags.Add("department","tech"); + newResourceGroup.Tags = tags; + // Use existing resource group name and new resource group object + newResourceGroup = await resourceGroupsClient.CreateOrUpdateAsync(resourceGroupName, newResourceGroup); +``` + + +***List all resource groups*** + +```csharp + AsyncPageable response = resourceGroupsClient.ListAsync(); + await foreach (ResourceGroup rg in response) + { + Console.WriteLine(rg.Name); + } +``` + +***Delete a resource group*** + +```csharp + await resourceGroupsClient.StartDeleteAsync(groupName); +``` + +Example: Creating a Virtual Machine +----------------------------------- +Let's show a concrete example of how you would create a virtual machine using .NET SDK +```csharp +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; + +using Azure.Identity; +using Azure.ResourceManager.Compute; +using Azure.ResourceManager.Compute.Models; +using Azure.ResourceManager.Network; +using Azure.ResourceManager.Network.Models; +using Azure.ResourceManager.Resources; +using Azure.ResourceManager.Resources.Models; + +namespace AzureCreateVMSample +{ + /// + /// Create a Virtual Machine + /// + public class CreateVMSample + { + public static async Task CreateVmAsync( + string subscriptionId, + string resourceGroupName, + string location, + string vmName) + { + var computeClient = new ComputeManagementClient(subscriptionId, new DefaultAzureCredential()); + var networkClient = new NetworkManagementClient(subscriptionId, new DefaultAzureCredential()); + var resourcesClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); + + var virtualNetworksClient = networkClient.GetVirtualNetworksClient(); + var networkInterfaceClient = networkClient.GetNetworkInterfacesClient(); + var publicIpAddressClient = networkClient.GetPublicIPAddresssesClient(); + var availabilitySetsClient = computeClient.GetAvailabilitySetsClient(); + var virtualMachinesClient = computeClient.GetVirtualMachinesClient(); + var resourceGroupClient = resourcesClient..GetResourceGroupsClient(); + + // Create Resource Group + var resourceGroup = new ResourceGroup(location); + resourceGroup = await resourceGroupClient.CreateOrUpdateAsync(resourceGroupName, resourceGroup); + + // Create AvailabilitySet + var availabilitySet = new AvailabilitySet(location) + { + PlatformUpdateDomainCount = 5, + PlatformFaultDomainCount = 2, + Sku = new Sku() { Name = "Aligned" } // TODO. Verify new codegen on AvailabilitySetSkuTypes.Aligned + }; + + availabilitySet = await availabilitySetsClient.CreateOrUpdateAsync(resourceGroupName, vmName + "_aSet", availabilitySet); + + // Create IP Address + var ipAddress = new PublicIPAddress() + { + PublicIPAddressVersion = IPVersion.IPv4, + PublicIPAllocationMethod = IPAllocationMethod.Dynamic, + Location = location, + }; + + ipAddress = await publicIpAddressClient.StartCreateOrUpdate(resourceGroupName, vmName + "_ip", ipAddress) + .WaitForCompletionAsync(); + + // Create VNet + var vnet = new VirtualNetwork() + { + Location = location, + AddressSpace = new AddressSpace() { AddressPrefixes = new List() { "10.0.0.0/16" } }, + Subnets = new List() + { + new Subnet() + { + Name = "mySubnet", + AddressPrefix = "10.0.0.0/24", + } + }, + }; + + vnet = await virtualNetworksClient + .StartCreateOrUpdate(resourceGroupName, vmName + "_vent", vnet) + .WaitForCompletionAsync(); + + // Create Network interface + var nic = new NetworkInterface() + { + Location = location, + IpConfigurations = new List() + { + new NetworkInterfaceIPConfiguration() + { + Name = "Primary", + Primary = true, + Subnet = new Subnet() { Id = vnet.Subnets.First().Id }, + PrivateIPAllocationMethod = IPAllocationMethod.Dynamic, + PublicIPAddress = new PublicIPAddress() { Id = ipAddress.Id } + } + } + }; + + nic = await networkInterfaceClient + .StartCreateOrUpdate(resourceGroupName, vmName + "_nic", nic) + .WaitForCompletionAsync(); + + var vm = new VirtualMachine(location) + { + NetworkProfile = new Compute.Models.NetworkProfile { NetworkInterfaces = new[] { new NetworkInterfaceReference() { Id = nic.Id } } }, + OsProfile = new OSProfile + { + ComputerName = "testVM", + AdminUsername = "username", + AdminPassword = "(YourPassword)", + LinuxConfiguration = new LinuxConfiguration { DisablePasswordAuthentication = false, ProvisionVMAgent = true } + }, + StorageProfile = new StorageProfile() + { + ImageReference = new ImageReference() + { + Offer = "UbuntuServer", + Publisher = "Canonical", + Sku = "18.04-LTS", + Version = "latest" + }, + DataDisks = new List() + }, + HardwareProfile = new HardwareProfile() { VmSize = VirtualMachineSizeTypes.StandardB1Ms }, + }; + vm.AvailabilitySet.Id = availabilitySet.Id; + + var operaiontion = await virtualMachinesClient.StartCreateOrUpdateAsync(resourceGroupName, vmName, vm); + var vm = (await operaiontion.WaitForCompletionAsync()).Value; + } + } +} + +``` + +Driver program + +```csharp +using System; +using System.Threading.Tasks; + +namespace AzureCreateVMSample +{ + class Program + { + static async Task Main(string[] args) + { + var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); + var location = "westus2"; + + await CreateVMSample.CreateVmAsync(subscriptionId, "myResourceGroupName", location, "myVirtualMachine"); + } + } +} +``` + +Need help? +---------- + +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) and + make sure you add the "Preview" label to the issue +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. + +Contributing +------------ + +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . + +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. + +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. From e4879a2bdad500039f662bc4c0e101ebc4b51a3e Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:21:27 +0800 Subject: [PATCH 10/20] Update root readme --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eb14cd58e29a..a85ec8a58e65 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,13 @@ To get started with a library, see the README.md file located in the library's p For tutorials, samples, quick starts, and other documentation, go to [Azure for .NET Developers](https://docs.microsoft.com/en-us/dotnet/azure/). ## Packages available +Each service might have a number of libraries available from each of the following categories: +* [Client - New Releases](#Client-New-Releases) +* [Client - Previous Versions](#Client-Previous-Versions) +* [Management - New Releases](#Management-New-Releases) +* [Management - Previous Versions](#Management-Previous-Versions) -### Client +### Client: New Releases New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries follow the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet/guidelines/) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure.Core](sdk/core/Azure.Core/README.md). @@ -26,9 +31,17 @@ For a complete list of available packages, please see the [latest available pack Last stable versions of packages that are production-ready. These libraries provide similar functionalities to the preview packages, as they allow you to use and consume existing resources and interact with them, for example: upload a storage blob. Stable library directories typically contain 'Microsoft.Azure' in their names, e.g. 'Microsoft.Azure.KeyVault'. They might not implement the [guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html) or have the same feature set as the Novemeber releases. They do however offer wider coverage of services. -### Management +### Management: New Releases +A new set of management libraries that follow the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet_introduction.html) and based on [Azure.Core libraries](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core) are now in Public Preview. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. You can find the list of new packages [on this page](https://azure.github.io/azure-sdk/releases/latest/dotnet.html). -Libraries which enable you to provision specific server resources. They are directly mirroring Azure service's REST endpoints. Management library directories typically contain the word 'Management' in their names, e.g. 'Microsoft.Azure.Management.Storage'. +To get started with these new libraries, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md). These new libraries can be identifed by namespaces that start with `Azure.ResourceManager`, e.g. `Azure.ResourceManager.Network` + +> NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries. + +### Management: Previous Versions +For a complete list of management libraries which enable you to provision and manage Azure resources, please check [here](https://azure.github.io/azure-sdk/releases/latest/all/dotnet.html). They might not have the same feature set as the new releases but they do offer wider coverage of services. Previous versions of management libraries can be identified by namespaces that start with `Microsoft.Azure.Management`, e.g. `Microsoft.Azure.Management.Network` + +Documentation and code samples for these libraries can be found [here](https://azure.github.io/azure-sdk-for-net). ## Need help? From 4708bc9665e0fec41cb0f7fb21fd1f1fa2b5e358 Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Thu, 18 Jun 2020 23:24:50 +0800 Subject: [PATCH 11/20] Update quickstart --- doc/mgmt_preview_quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md index 4f25baa425ca..fad203fe6791 100644 --- a/doc/mgmt_preview_quickstart.md +++ b/doc/mgmt_preview_quickstart.md @@ -79,7 +79,7 @@ Now that the environment is setup, all you need to do is to create an authenticated client. Our default option is to use **DefaultAzureCredential** and in this guide we have picked **Resources** as our target service, but you can set it up similarly for -any other service that you are using. +any other service that you are using. **For example, in order to manage Compute or Network resources, you would create a ``ComputeManagementClient`` or ``NetworkManagementClient``** To authenticate to Azure and create a management client, simply do the following: From 2ef39edcb31706cb3792fe3179982ae03fa44807 Mon Sep 17 00:00:00 2001 From: Nick Zhu Date: Mon, 22 Jun 2020 13:14:07 +0800 Subject: [PATCH 12/20] Revert readme and quickstart --- README.md | 19 +- doc/mgmt_preview_quickstart.md | 338 --------------------------------- 2 files changed, 3 insertions(+), 354 deletions(-) delete mode 100644 doc/mgmt_preview_quickstart.md diff --git a/README.md b/README.md index a85ec8a58e65..eb14cd58e29a 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,8 @@ To get started with a library, see the README.md file located in the library's p For tutorials, samples, quick starts, and other documentation, go to [Azure for .NET Developers](https://docs.microsoft.com/en-us/dotnet/azure/). ## Packages available -Each service might have a number of libraries available from each of the following categories: -* [Client - New Releases](#Client-New-Releases) -* [Client - Previous Versions](#Client-Previous-Versions) -* [Management - New Releases](#Management-New-Releases) -* [Management - Previous Versions](#Management-Previous-Versions) -### Client: New Releases +### Client New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries follow the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet/guidelines/) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure.Core](sdk/core/Azure.Core/README.md). @@ -31,17 +26,9 @@ For a complete list of available packages, please see the [latest available pack Last stable versions of packages that are production-ready. These libraries provide similar functionalities to the preview packages, as they allow you to use and consume existing resources and interact with them, for example: upload a storage blob. Stable library directories typically contain 'Microsoft.Azure' in their names, e.g. 'Microsoft.Azure.KeyVault'. They might not implement the [guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html) or have the same feature set as the Novemeber releases. They do however offer wider coverage of services. -### Management: New Releases -A new set of management libraries that follow the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet_introduction.html) and based on [Azure.Core libraries](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core) are now in Public Preview. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. You can find the list of new packages [on this page](https://azure.github.io/azure-sdk/releases/latest/dotnet.html). +### Management -To get started with these new libraries, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md). These new libraries can be identifed by namespaces that start with `Azure.ResourceManager`, e.g. `Azure.ResourceManager.Network` - -> NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries. - -### Management: Previous Versions -For a complete list of management libraries which enable you to provision and manage Azure resources, please check [here](https://azure.github.io/azure-sdk/releases/latest/all/dotnet.html). They might not have the same feature set as the new releases but they do offer wider coverage of services. Previous versions of management libraries can be identified by namespaces that start with `Microsoft.Azure.Management`, e.g. `Microsoft.Azure.Management.Network` - -Documentation and code samples for these libraries can be found [here](https://azure.github.io/azure-sdk-for-net). +Libraries which enable you to provision specific server resources. They are directly mirroring Azure service's REST endpoints. Management library directories typically contain the word 'Management' in their names, e.g. 'Microsoft.Azure.Management.Storage'. ## Need help? diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md deleted file mode 100644 index fad203fe6791..000000000000 --- a/doc/mgmt_preview_quickstart.md +++ /dev/null @@ -1,338 +0,0 @@ - -Quickstart Tutorial - Resource Management (Preview Libraries) -============================================================= - -We are excited to announce that a new set of management libraries are -now in Public Preview. Those packages share a number of new features -such as Azure Identity support, HTTP pipeline, error-handling.,etc, and -they also follow the new Azure SDK guidelines which create easy-to-use -APIs that are idiomatic, compatible, and dependable. - -You can find the details of those new libraries -[here](https://azure.github.io/azure-sdk/releases/latest/#dotnet) - -In this basic quickstart guide, we will walk you through how to -authenticate to Azure using the preview libraries and start interacting -with Azure resources. There are several possible approaches to -authentication. This document illustrates the most common scenario - -Prerequisites -------------- - -You will need the following values to authenticate to Azure - -- **Subscription ID** -- **Client ID** -- **Client Secret** -- **Tenant ID** - -These values can be obtained from the portal, here's the instructions: - -### Get Subscription ID - -1. Login into your Azure account -2. Select Subscriptions in the left sidebar -3. Select whichever subscription is needed -4. Click on Overview -5. Copy the Subscription ID - -### Get Client ID / Client Secret / Tenant ID - -For information on how to get Client ID, Client Secret, and Tenant ID, -please refer to [this -document](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal) - -### Setting Environment Variables - -After you obtained the values, you need to set the following values as -your environment variables - -- `AZURE_CLIENT_ID` -- `AZURE_CLIENT_SECRET` -- `AZURE_TENANT_ID` -- `AZURE_SUBSCRIPTION_ID` - -To set the following environment variables on your development system: - -Windows (Note: Administrator access is required) - -1. Open the Control Panel -2. Click System Security, then System -3. Click Advanced system settings on the left -4. Inside the System Properties window, click the Environment - Variables… button. -5. Click on the property you would like to change, then click the Edit… - button. If the property name is not listed, then click the New… - button. - -Linux-based OS : - - export AZURE_CLIENT_ID="__CLIENT_ID__" - export AZURE_CLIENT_SECRET="__CLIENT_SECRET__" - export AZURE_TENANT_ID="__TENANT_ID__" - export AZURE_SUBSCRIPTION_ID="__SUBSCRIPTION_ID__" - -Authentication and Creating Resource Management Client ------------------------------------------------------- - -Now that the environment is setup, all you need to do is to create an -authenticated client. Our default option is to use -**DefaultAzureCredential** and in this guide we have picked -**Resources** as our target service, but you can set it up similarly for -any other service that you are using. **For example, in order to manage Compute or Network resources, you would create a ``ComputeManagementClient`` or ``NetworkManagementClient``** - -To authenticate to Azure and create a management client, simply do the -following: -```csharp - using Azure.Identity; - using Azure.ResourceManager.Resources; - using Azure.ResourceManager.Resources.Models; - using System; - ... - var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); - var resourceClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); - var resourceGroupsClient = resourceClient.GetResourceGroupsClient(); -``` -From this code snippet, we showed that in order to interact with Resources, we need to create a top-level client first (**ResourcesManagementClient**), then get the corresponding sub-resource client we are interested in, in this case we called **.GetResourceGroupsClient()** to get a ResourceGroupsClient - -For more information and different authentication approaches using Azure -Identity can be found in [this document](https://docs.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet) - -Interacting with Azure Resources --------------------------------- - -Now that we are authenticated, we can use our management client to make API calls. Let's demonstrate management client's usage by showing concrete examples - -Example: Managing Resource Groups ---------------------------------- -We can use the Resource client (``Azure.ResourceManager.Resources.ResourcesManagementClient``) we have created to perform operations on Resource Group. In this example, we will show to manage Resource Groups. - -***Create a resource group*** - -```csharp - var location = "westus2"; - var resourceGroupName = "myResourceGroupName"; - var resourceGroup = new ResourceGroup(location); - resourceGroup = await resourceGroupsClient.CreateOrUpdateAsync(resourceGroupName, resourceGroup); -``` - -***Update a resource group*** - -```csharp - ... - var newResourceGroup = new ResourceGroup(location); - var resourceGroupName = "myResourceGroupName"; - var tags = new Dictionary(); - tags.Add("environment","test"); - tags.Add("department","tech"); - newResourceGroup.Tags = tags; - // Use existing resource group name and new resource group object - newResourceGroup = await resourceGroupsClient.CreateOrUpdateAsync(resourceGroupName, newResourceGroup); -``` - - -***List all resource groups*** - -```csharp - AsyncPageable response = resourceGroupsClient.ListAsync(); - await foreach (ResourceGroup rg in response) - { - Console.WriteLine(rg.Name); - } -``` - -***Delete a resource group*** - -```csharp - await resourceGroupsClient.StartDeleteAsync(groupName); -``` - -Example: Creating a Virtual Machine ------------------------------------ -Let's show a concrete example of how you would create a virtual machine using .NET SDK -```csharp -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; - -using Azure.Identity; -using Azure.ResourceManager.Compute; -using Azure.ResourceManager.Compute.Models; -using Azure.ResourceManager.Network; -using Azure.ResourceManager.Network.Models; -using Azure.ResourceManager.Resources; -using Azure.ResourceManager.Resources.Models; - -namespace AzureCreateVMSample -{ - /// - /// Create a Virtual Machine - /// - public class CreateVMSample - { - public static async Task CreateVmAsync( - string subscriptionId, - string resourceGroupName, - string location, - string vmName) - { - var computeClient = new ComputeManagementClient(subscriptionId, new DefaultAzureCredential()); - var networkClient = new NetworkManagementClient(subscriptionId, new DefaultAzureCredential()); - var resourcesClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); - - var virtualNetworksClient = networkClient.GetVirtualNetworksClient(); - var networkInterfaceClient = networkClient.GetNetworkInterfacesClient(); - var publicIpAddressClient = networkClient.GetPublicIPAddresssesClient(); - var availabilitySetsClient = computeClient.GetAvailabilitySetsClient(); - var virtualMachinesClient = computeClient.GetVirtualMachinesClient(); - var resourceGroupClient = resourcesClient..GetResourceGroupsClient(); - - // Create Resource Group - var resourceGroup = new ResourceGroup(location); - resourceGroup = await resourceGroupClient.CreateOrUpdateAsync(resourceGroupName, resourceGroup); - - // Create AvailabilitySet - var availabilitySet = new AvailabilitySet(location) - { - PlatformUpdateDomainCount = 5, - PlatformFaultDomainCount = 2, - Sku = new Sku() { Name = "Aligned" } // TODO. Verify new codegen on AvailabilitySetSkuTypes.Aligned - }; - - availabilitySet = await availabilitySetsClient.CreateOrUpdateAsync(resourceGroupName, vmName + "_aSet", availabilitySet); - - // Create IP Address - var ipAddress = new PublicIPAddress() - { - PublicIPAddressVersion = IPVersion.IPv4, - PublicIPAllocationMethod = IPAllocationMethod.Dynamic, - Location = location, - }; - - ipAddress = await publicIpAddressClient.StartCreateOrUpdate(resourceGroupName, vmName + "_ip", ipAddress) - .WaitForCompletionAsync(); - - // Create VNet - var vnet = new VirtualNetwork() - { - Location = location, - AddressSpace = new AddressSpace() { AddressPrefixes = new List() { "10.0.0.0/16" } }, - Subnets = new List() - { - new Subnet() - { - Name = "mySubnet", - AddressPrefix = "10.0.0.0/24", - } - }, - }; - - vnet = await virtualNetworksClient - .StartCreateOrUpdate(resourceGroupName, vmName + "_vent", vnet) - .WaitForCompletionAsync(); - - // Create Network interface - var nic = new NetworkInterface() - { - Location = location, - IpConfigurations = new List() - { - new NetworkInterfaceIPConfiguration() - { - Name = "Primary", - Primary = true, - Subnet = new Subnet() { Id = vnet.Subnets.First().Id }, - PrivateIPAllocationMethod = IPAllocationMethod.Dynamic, - PublicIPAddress = new PublicIPAddress() { Id = ipAddress.Id } - } - } - }; - - nic = await networkInterfaceClient - .StartCreateOrUpdate(resourceGroupName, vmName + "_nic", nic) - .WaitForCompletionAsync(); - - var vm = new VirtualMachine(location) - { - NetworkProfile = new Compute.Models.NetworkProfile { NetworkInterfaces = new[] { new NetworkInterfaceReference() { Id = nic.Id } } }, - OsProfile = new OSProfile - { - ComputerName = "testVM", - AdminUsername = "username", - AdminPassword = "(YourPassword)", - LinuxConfiguration = new LinuxConfiguration { DisablePasswordAuthentication = false, ProvisionVMAgent = true } - }, - StorageProfile = new StorageProfile() - { - ImageReference = new ImageReference() - { - Offer = "UbuntuServer", - Publisher = "Canonical", - Sku = "18.04-LTS", - Version = "latest" - }, - DataDisks = new List() - }, - HardwareProfile = new HardwareProfile() { VmSize = VirtualMachineSizeTypes.StandardB1Ms }, - }; - vm.AvailabilitySet.Id = availabilitySet.Id; - - var operaiontion = await virtualMachinesClient.StartCreateOrUpdateAsync(resourceGroupName, vmName, vm); - var vm = (await operaiontion.WaitForCompletionAsync()).Value; - } - } -} - -``` - -Driver program - -```csharp -using System; -using System.Threading.Tasks; - -namespace AzureCreateVMSample -{ - class Program - { - static async Task Main(string[] args) - { - var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); - var location = "westus2"; - - await CreateVMSample.CreateVmAsync(subscriptionId, "myResourceGroupName", location, "myVirtualMachine"); - } - } -} -``` - -Need help? ----------- - -- File an issue via [Github - Issues](https://github.com/Azure/azure-sdk-for-net/issues) and - make sure you add the "Preview" label to the issue -- Check [previous - questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. - -Contributing ------------- - -For details on contributing to this repository, see the contributing -guide. - -This project welcomes contributions and suggestions. Most contributions -require you to agree to a Contributor License Agreement (CLA) declaring -that you have the right to, and actually do, grant us the rights to use -your contribution. For details, visit . - -When you submit a pull request, a CLA-bot will automatically determine -whether you need to provide a CLA and decorate the PR appropriately -(e.g., label, comment). Simply follow the instructions provided by the -bot. You will only need to do this once across all repositories using -our CLA. - -This project has adopted the Microsoft Open Source Code of Conduct. For -more information see the Code of Conduct FAQ or contact - with any additional questions or comments. From 28b6a1ccf50485ba2eaa8e181cfef7c6f09eeb91 Mon Sep 17 00:00:00 2001 From: Nick Zhu Date: Mon, 22 Jun 2020 13:27:05 +0800 Subject: [PATCH 13/20] Update event hub readme --- doc/mgmt_preview_quickstart.md | 338 ++++++++++++++++++ .../Azure.ResourceManager.EventHubs/README.md | 10 +- 2 files changed, 343 insertions(+), 5 deletions(-) create mode 100644 doc/mgmt_preview_quickstart.md diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md new file mode 100644 index 000000000000..fad203fe6791 --- /dev/null +++ b/doc/mgmt_preview_quickstart.md @@ -0,0 +1,338 @@ + +Quickstart Tutorial - Resource Management (Preview Libraries) +============================================================= + +We are excited to announce that a new set of management libraries are +now in Public Preview. Those packages share a number of new features +such as Azure Identity support, HTTP pipeline, error-handling.,etc, and +they also follow the new Azure SDK guidelines which create easy-to-use +APIs that are idiomatic, compatible, and dependable. + +You can find the details of those new libraries +[here](https://azure.github.io/azure-sdk/releases/latest/#dotnet) + +In this basic quickstart guide, we will walk you through how to +authenticate to Azure using the preview libraries and start interacting +with Azure resources. There are several possible approaches to +authentication. This document illustrates the most common scenario + +Prerequisites +------------- + +You will need the following values to authenticate to Azure + +- **Subscription ID** +- **Client ID** +- **Client Secret** +- **Tenant ID** + +These values can be obtained from the portal, here's the instructions: + +### Get Subscription ID + +1. Login into your Azure account +2. Select Subscriptions in the left sidebar +3. Select whichever subscription is needed +4. Click on Overview +5. Copy the Subscription ID + +### Get Client ID / Client Secret / Tenant ID + +For information on how to get Client ID, Client Secret, and Tenant ID, +please refer to [this +document](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal) + +### Setting Environment Variables + +After you obtained the values, you need to set the following values as +your environment variables + +- `AZURE_CLIENT_ID` +- `AZURE_CLIENT_SECRET` +- `AZURE_TENANT_ID` +- `AZURE_SUBSCRIPTION_ID` + +To set the following environment variables on your development system: + +Windows (Note: Administrator access is required) + +1. Open the Control Panel +2. Click System Security, then System +3. Click Advanced system settings on the left +4. Inside the System Properties window, click the Environment + Variables… button. +5. Click on the property you would like to change, then click the Edit… + button. If the property name is not listed, then click the New… + button. + +Linux-based OS : + + export AZURE_CLIENT_ID="__CLIENT_ID__" + export AZURE_CLIENT_SECRET="__CLIENT_SECRET__" + export AZURE_TENANT_ID="__TENANT_ID__" + export AZURE_SUBSCRIPTION_ID="__SUBSCRIPTION_ID__" + +Authentication and Creating Resource Management Client +------------------------------------------------------ + +Now that the environment is setup, all you need to do is to create an +authenticated client. Our default option is to use +**DefaultAzureCredential** and in this guide we have picked +**Resources** as our target service, but you can set it up similarly for +any other service that you are using. **For example, in order to manage Compute or Network resources, you would create a ``ComputeManagementClient`` or ``NetworkManagementClient``** + +To authenticate to Azure and create a management client, simply do the +following: +```csharp + using Azure.Identity; + using Azure.ResourceManager.Resources; + using Azure.ResourceManager.Resources.Models; + using System; + ... + var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); + var resourceClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); + var resourceGroupsClient = resourceClient.GetResourceGroupsClient(); +``` +From this code snippet, we showed that in order to interact with Resources, we need to create a top-level client first (**ResourcesManagementClient**), then get the corresponding sub-resource client we are interested in, in this case we called **.GetResourceGroupsClient()** to get a ResourceGroupsClient + +For more information and different authentication approaches using Azure +Identity can be found in [this document](https://docs.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet) + +Interacting with Azure Resources +-------------------------------- + +Now that we are authenticated, we can use our management client to make API calls. Let's demonstrate management client's usage by showing concrete examples + +Example: Managing Resource Groups +--------------------------------- +We can use the Resource client (``Azure.ResourceManager.Resources.ResourcesManagementClient``) we have created to perform operations on Resource Group. In this example, we will show to manage Resource Groups. + +***Create a resource group*** + +```csharp + var location = "westus2"; + var resourceGroupName = "myResourceGroupName"; + var resourceGroup = new ResourceGroup(location); + resourceGroup = await resourceGroupsClient.CreateOrUpdateAsync(resourceGroupName, resourceGroup); +``` + +***Update a resource group*** + +```csharp + ... + var newResourceGroup = new ResourceGroup(location); + var resourceGroupName = "myResourceGroupName"; + var tags = new Dictionary(); + tags.Add("environment","test"); + tags.Add("department","tech"); + newResourceGroup.Tags = tags; + // Use existing resource group name and new resource group object + newResourceGroup = await resourceGroupsClient.CreateOrUpdateAsync(resourceGroupName, newResourceGroup); +``` + + +***List all resource groups*** + +```csharp + AsyncPageable response = resourceGroupsClient.ListAsync(); + await foreach (ResourceGroup rg in response) + { + Console.WriteLine(rg.Name); + } +``` + +***Delete a resource group*** + +```csharp + await resourceGroupsClient.StartDeleteAsync(groupName); +``` + +Example: Creating a Virtual Machine +----------------------------------- +Let's show a concrete example of how you would create a virtual machine using .NET SDK +```csharp +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; + +using Azure.Identity; +using Azure.ResourceManager.Compute; +using Azure.ResourceManager.Compute.Models; +using Azure.ResourceManager.Network; +using Azure.ResourceManager.Network.Models; +using Azure.ResourceManager.Resources; +using Azure.ResourceManager.Resources.Models; + +namespace AzureCreateVMSample +{ + /// + /// Create a Virtual Machine + /// + public class CreateVMSample + { + public static async Task CreateVmAsync( + string subscriptionId, + string resourceGroupName, + string location, + string vmName) + { + var computeClient = new ComputeManagementClient(subscriptionId, new DefaultAzureCredential()); + var networkClient = new NetworkManagementClient(subscriptionId, new DefaultAzureCredential()); + var resourcesClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); + + var virtualNetworksClient = networkClient.GetVirtualNetworksClient(); + var networkInterfaceClient = networkClient.GetNetworkInterfacesClient(); + var publicIpAddressClient = networkClient.GetPublicIPAddresssesClient(); + var availabilitySetsClient = computeClient.GetAvailabilitySetsClient(); + var virtualMachinesClient = computeClient.GetVirtualMachinesClient(); + var resourceGroupClient = resourcesClient..GetResourceGroupsClient(); + + // Create Resource Group + var resourceGroup = new ResourceGroup(location); + resourceGroup = await resourceGroupClient.CreateOrUpdateAsync(resourceGroupName, resourceGroup); + + // Create AvailabilitySet + var availabilitySet = new AvailabilitySet(location) + { + PlatformUpdateDomainCount = 5, + PlatformFaultDomainCount = 2, + Sku = new Sku() { Name = "Aligned" } // TODO. Verify new codegen on AvailabilitySetSkuTypes.Aligned + }; + + availabilitySet = await availabilitySetsClient.CreateOrUpdateAsync(resourceGroupName, vmName + "_aSet", availabilitySet); + + // Create IP Address + var ipAddress = new PublicIPAddress() + { + PublicIPAddressVersion = IPVersion.IPv4, + PublicIPAllocationMethod = IPAllocationMethod.Dynamic, + Location = location, + }; + + ipAddress = await publicIpAddressClient.StartCreateOrUpdate(resourceGroupName, vmName + "_ip", ipAddress) + .WaitForCompletionAsync(); + + // Create VNet + var vnet = new VirtualNetwork() + { + Location = location, + AddressSpace = new AddressSpace() { AddressPrefixes = new List() { "10.0.0.0/16" } }, + Subnets = new List() + { + new Subnet() + { + Name = "mySubnet", + AddressPrefix = "10.0.0.0/24", + } + }, + }; + + vnet = await virtualNetworksClient + .StartCreateOrUpdate(resourceGroupName, vmName + "_vent", vnet) + .WaitForCompletionAsync(); + + // Create Network interface + var nic = new NetworkInterface() + { + Location = location, + IpConfigurations = new List() + { + new NetworkInterfaceIPConfiguration() + { + Name = "Primary", + Primary = true, + Subnet = new Subnet() { Id = vnet.Subnets.First().Id }, + PrivateIPAllocationMethod = IPAllocationMethod.Dynamic, + PublicIPAddress = new PublicIPAddress() { Id = ipAddress.Id } + } + } + }; + + nic = await networkInterfaceClient + .StartCreateOrUpdate(resourceGroupName, vmName + "_nic", nic) + .WaitForCompletionAsync(); + + var vm = new VirtualMachine(location) + { + NetworkProfile = new Compute.Models.NetworkProfile { NetworkInterfaces = new[] { new NetworkInterfaceReference() { Id = nic.Id } } }, + OsProfile = new OSProfile + { + ComputerName = "testVM", + AdminUsername = "username", + AdminPassword = "(YourPassword)", + LinuxConfiguration = new LinuxConfiguration { DisablePasswordAuthentication = false, ProvisionVMAgent = true } + }, + StorageProfile = new StorageProfile() + { + ImageReference = new ImageReference() + { + Offer = "UbuntuServer", + Publisher = "Canonical", + Sku = "18.04-LTS", + Version = "latest" + }, + DataDisks = new List() + }, + HardwareProfile = new HardwareProfile() { VmSize = VirtualMachineSizeTypes.StandardB1Ms }, + }; + vm.AvailabilitySet.Id = availabilitySet.Id; + + var operaiontion = await virtualMachinesClient.StartCreateOrUpdateAsync(resourceGroupName, vmName, vm); + var vm = (await operaiontion.WaitForCompletionAsync()).Value; + } + } +} + +``` + +Driver program + +```csharp +using System; +using System.Threading.Tasks; + +namespace AzureCreateVMSample +{ + class Program + { + static async Task Main(string[] args) + { + var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); + var location = "westus2"; + + await CreateVMSample.CreateVmAsync(subscriptionId, "myResourceGroupName", location, "myVirtualMachine"); + } + } +} +``` + +Need help? +---------- + +- File an issue via [Github + Issues](https://github.com/Azure/azure-sdk-for-net/issues) and + make sure you add the "Preview" label to the issue +- Check [previous + questions](https://stackoverflow.com/questions/tagged/azure+.net) + or ask new ones on StackOverflow using azure and .NET tags. + +Contributing +------------ + +For details on contributing to this repository, see the contributing +guide. + +This project welcomes contributions and suggestions. Most contributions +require you to agree to a Contributor License Agreement (CLA) declaring +that you have the right to, and actually do, grant us the rights to use +your contribution. For details, visit . + +When you submit a pull request, a CLA-bot will automatically determine +whether you need to provide a CLA and decorate the PR appropriately +(e.g., label, comment). Simply follow the instructions provided by the +bot. You will only need to do this once across all repositories using +our CLA. + +This project has adopted the Microsoft Open Source Code of Conduct. For +more information see the Code of Conduct FAQ or contact + with any additional questions or comments. diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index c924a842ab58..a29f41c45e8e 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -1,4 +1,4 @@ -# Azure Management EventHubs client library for .NET +# Azure Event Hubs Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,15 +8,15 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management EventHubs client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Event Hubs management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.EventHubs +Install-Package Azure.ResourceManager.EventHubs -Version 1.0.0-preview.1 ``` ## Documentation -Various documentation is available to help you learn how to use this package +Various forms of documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing From b8b9ce355789047b4166cdbb72ddc9223b3f3e23 Mon Sep 17 00:00:00 2001 From: Nick Zhu Date: Mon, 22 Jun 2020 13:48:39 +0800 Subject: [PATCH 14/20] Update readme based on review comments --- .../Azure.ResourceManager.AppConfiguration/README.md | 10 +++++----- sdk/compute/Azure.ResourceManager.Compute/README.md | 10 +++++----- sdk/eventhub/Azure.ResourceManager.EventHubs/README.md | 2 +- sdk/keyvault/Azure.ResourceManager.KeyVault/README.md | 8 ++++---- sdk/network/Azure.ResourceManager.Network/README.md | 10 +++++----- .../Azure.ResourceManager.Resources/README.md | 10 +++++----- sdk/storage/Azure.ResourceManager.Storage/README.md | 10 +++++----- 7 files changed, 30 insertions(+), 30 deletions(-) diff --git a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md index f54eb77bd68e..9aa8701c08d3 100644 --- a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md +++ b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md @@ -1,4 +1,4 @@ -# Azure Management AppConfiguration client library for .NET +# Azure App Configuration Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,15 +8,15 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management App Configuration client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure App Configuration management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.AppConfiguration +Install-Package Azure.ResourceManager.AppConfiguration -Version 1.0.0-preview.1 ``` ## Documentation -Various documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing diff --git a/sdk/compute/Azure.ResourceManager.Compute/README.md b/sdk/compute/Azure.ResourceManager.Compute/README.md index 7268f766c003..89b86275fad3 100644 --- a/sdk/compute/Azure.ResourceManager.Compute/README.md +++ b/sdk/compute/Azure.ResourceManager.Compute/README.md @@ -1,4 +1,4 @@ -# Azure Management Compute client library for .NET +# Azure Compute Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,15 +8,15 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management Compute client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Compute management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.Compute +Install-Package Azure.ResourceManager.Compute -Version 1.0.0-preview.1 ``` ## Documentation -Various documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index a29f41c45e8e..a60c454e3695 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -16,7 +16,7 @@ Install-Package Azure.ResourceManager.EventHubs -Version 1.0.0-preview.1 ## Documentation -Various forms of documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) diff --git a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md index 3edf0c013bf4..3438360de4d9 100644 --- a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md +++ b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md @@ -1,4 +1,4 @@ -# Azure Management KeyVault client library for .NET +# Azure Key Vault Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,10 +8,10 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management KeyVault client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Key Vault management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.KeyVault +Install-Package Azure.ResourceManager.KeyVault -Version 1.0.0-preview.1 ``` ## Documentation @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing diff --git a/sdk/network/Azure.ResourceManager.Network/README.md b/sdk/network/Azure.ResourceManager.Network/README.md index 087174d34dcc..9324fc37958d 100644 --- a/sdk/network/Azure.ResourceManager.Network/README.md +++ b/sdk/network/Azure.ResourceManager.Network/README.md @@ -1,4 +1,4 @@ -# Azure Management Network client library for .NET +# Azure Network Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,15 +8,15 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management Network client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Network management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.Network +Install-Package Azure.ResourceManager.Network -Version 1.0.0-preview.1 ``` ## Documentation -Various documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index e0aeb687136d..a2970ed59def 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -1,4 +1,4 @@ -# Azure Management Resources client library for .NET +# Azure Resources Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,15 +8,15 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management Resources client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Resources management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.Resources +Install-Package Azure.ResourceManager.Resources -Version 1.0.0-preview.1 ``` ## Documentation -Various documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing diff --git a/sdk/storage/Azure.ResourceManager.Storage/README.md b/sdk/storage/Azure.ResourceManager.Storage/README.md index 1d6ced4db471..e49795e20f73 100644 --- a/sdk/storage/Azure.ResourceManager.Storage/README.md +++ b/sdk/storage/Azure.ResourceManager.Storage/README.md @@ -1,4 +1,4 @@ -# Azure Management Storage client library for .NET +# Azure Storage Management Library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. @@ -8,15 +8,15 @@ To create an authenticated client and start interacting with Azure resources, pl ### Install the package -Install the Azure Management Storage client library for .NET with [NuGet](https://www.nuget.org/): +Install the Azure Storage management library for .NET with [NuGet](https://www.nuget.org/): ```PowerShell -Install-Package Azure.ResourceManager.Storage +Install-Package Azure.ResourceManager.Storage -Version 1.0.0-preview.1 ``` ## Documentation -Various documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) @@ -28,7 +28,7 @@ Various documentation is available to help you learn how to use this package Issues](https://github.com/Azure/azure-sdk-for-net/issues) - Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) - or ask new ones on StackOverflow using azure and .NET tags. + or ask new ones on Stack Overflow using azure and .net tags. ## Contributing From 1d361b8ba8788c32ab132690bc42858d40aeaf35 Mon Sep 17 00:00:00 2001 From: Nick Zhu Date: Mon, 22 Jun 2020 14:16:04 +0800 Subject: [PATCH 15/20] Update readme for CI pipeline requirements --- .../README.md | 32 ++++++++++++++--- .../Azure.ResourceManager.Compute/README.md | 32 ++++++++++++++--- .../Azure.ResourceManager.EventHubs/README.md | 32 ++++++++++++++--- .../Azure.ResourceManager.KeyVault/README.md | 34 +++++++++++++++---- .../Azure.ResourceManager.Network/README.md | 32 ++++++++++++++--- .../Azure.ResourceManager.Resources/README.md | 32 ++++++++++++++--- .../Azure.ResourceManager.Storage/README.md | 32 ++++++++++++++--- 7 files changed, 190 insertions(+), 36 deletions(-) diff --git a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md index 9aa8701c08d3..5771320a864f 100644 --- a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md +++ b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md @@ -1,10 +1,8 @@ -# Azure App Configuration Management Library for .NET +# Azure App Configuration Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,6 +12,16 @@ Install the Azure App Configuration management library for .NET with [NuGet](htt Install-Package Azure.ResourceManager.AppConfiguration -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation Documentation is available to help you learn how to use this package @@ -22,7 +30,12 @@ Documentation is available to help you learn how to use this package - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) diff --git a/sdk/compute/Azure.ResourceManager.Compute/README.md b/sdk/compute/Azure.ResourceManager.Compute/README.md index 89b86275fad3..adc8f56beb75 100644 --- a/sdk/compute/Azure.ResourceManager.Compute/README.md +++ b/sdk/compute/Azure.ResourceManager.Compute/README.md @@ -1,10 +1,8 @@ -# Azure Compute Management Library for .NET +# Azure Compute Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,6 +12,16 @@ Install the Azure Compute management library for .NET with [NuGet](https://www.n Install-Package Azure.ResourceManager.Compute -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation Documentation is available to help you learn how to use this package @@ -22,7 +30,12 @@ Documentation is available to help you learn how to use this package - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index a60c454e3695..cb6b6b6c42e2 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -1,10 +1,8 @@ -# Azure Event Hubs Management Library for .NET +# Azure Event Hubs Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,6 +12,16 @@ Install the Azure Event Hubs management library for .NET with [NuGet](https://ww Install-Package Azure.ResourceManager.EventHubs -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation Documentation is available to help you learn how to use this package @@ -22,7 +30,12 @@ Documentation is available to help you learn how to use this package - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) diff --git a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md index 3438360de4d9..602d5e59c4a1 100644 --- a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md +++ b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md @@ -1,10 +1,8 @@ -# Azure Key Vault Management Library for .NET +# Azure Key Vault Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,15 +12,30 @@ Install the Azure Key Vault management library for .NET with [NuGet](https://www Install-Package Azure.ResourceManager.KeyVault -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation -Various documentation is available to help you learn how to use this package +Documentation is available to help you learn how to use this package - [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Various documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) diff --git a/sdk/network/Azure.ResourceManager.Network/README.md b/sdk/network/Azure.ResourceManager.Network/README.md index 9324fc37958d..aa16093c4452 100644 --- a/sdk/network/Azure.ResourceManager.Network/README.md +++ b/sdk/network/Azure.ResourceManager.Network/README.md @@ -1,10 +1,8 @@ -# Azure Network Management Library for .NET +# Azure Network Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,6 +12,16 @@ Install the Azure Network management library for .NET with [NuGet](https://www.n Install-Package Azure.ResourceManager.Network -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation Documentation is available to help you learn how to use this package @@ -22,7 +30,12 @@ Documentation is available to help you learn how to use this package - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index a2970ed59def..3ebb737da4b6 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -1,10 +1,8 @@ -# Azure Resources Management Library for .NET +# Azure Resources Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,6 +12,16 @@ Install the Azure Resources management library for .NET with [NuGet](https://www Install-Package Azure.ResourceManager.Resources -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation Documentation is available to help you learn how to use this package @@ -22,7 +30,12 @@ Documentation is available to help you learn how to use this package - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) diff --git a/sdk/storage/Azure.ResourceManager.Storage/README.md b/sdk/storage/Azure.ResourceManager.Storage/README.md index e49795e20f73..6b45c15b05a4 100644 --- a/sdk/storage/Azure.ResourceManager.Storage/README.md +++ b/sdk/storage/Azure.ResourceManager.Storage/README.md @@ -1,10 +1,8 @@ -# Azure Storage Management Library for .NET +# Azure Compute Management client library for .NET This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html) which provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more. -## Getting started - -To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) +## Getting started ### Install the package @@ -14,6 +12,16 @@ Install the Azure Storage management library for .NET with [NuGet](https://www.n Install-Package Azure.ResourceManager.Storage -Version 1.0.0-preview.1 ``` +### Prerequisites + +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Authenticate the Client + +To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) + +## Key Concepts + ## Documentation Documentation is available to help you learn how to use this package @@ -22,7 +30,12 @@ Documentation is available to help you learn how to use this package - [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet) - [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/identity/Azure.Identity/README.md) -## Need help? +## Examples + +Code samples for using the management library for .NET can be found in the following locations +- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK) + +## Troubleshooting - File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues) @@ -30,6 +43,9 @@ Documentation is available to help you learn how to use this package questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using azure and .net tags. + +## Next steps + ## Contributing For details on contributing to this repository, see the contributing @@ -49,3 +65,9 @@ our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Ftemplate%2FAzure.Template%2FREADME.png) From b2c3ab6c2ee2fbdc3738aff7d1ed9b1b4a8dbb8e Mon Sep 17 00:00:00 2001 From: Nick Zhu Date: Mon, 22 Jun 2020 14:36:54 +0800 Subject: [PATCH 16/20] Update empty sections --- .../Azure.ResourceManager.AppConfiguration/README.md | 4 ++++ sdk/compute/Azure.ResourceManager.Compute/README.md | 4 ++++ sdk/eventhub/Azure.ResourceManager.EventHubs/README.md | 4 ++++ sdk/keyvault/Azure.ResourceManager.KeyVault/README.md | 4 ++++ sdk/network/Azure.ResourceManager.Network/README.md | 4 ++++ sdk/resources/Azure.ResourceManager.Resources/README.md | 4 ++++ sdk/storage/Azure.ResourceManager.Storage/README.md | 4 ++++ 7 files changed, 28 insertions(+) diff --git a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md index 5771320a864f..159b5e941b51 100644 --- a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md +++ b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing diff --git a/sdk/compute/Azure.ResourceManager.Compute/README.md b/sdk/compute/Azure.ResourceManager.Compute/README.md index adc8f56beb75..f7f5aaf1bca3 100644 --- a/sdk/compute/Azure.ResourceManager.Compute/README.md +++ b/sdk/compute/Azure.ResourceManager.Compute/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index cb6b6b6c42e2..7ae04b2c5995 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing diff --git a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md index 602d5e59c4a1..bb65e70d87fe 100644 --- a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md +++ b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing diff --git a/sdk/network/Azure.ResourceManager.Network/README.md b/sdk/network/Azure.ResourceManager.Network/README.md index aa16093c4452..1aed455d6d31 100644 --- a/sdk/network/Azure.ResourceManager.Network/README.md +++ b/sdk/network/Azure.ResourceManager.Network/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index 3ebb737da4b6..965958b7ff88 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing diff --git a/sdk/storage/Azure.ResourceManager.Storage/README.md b/sdk/storage/Azure.ResourceManager.Storage/README.md index 6b45c15b05a4..9e170d918ef8 100644 --- a/sdk/storage/Azure.ResourceManager.Storage/README.md +++ b/sdk/storage/Azure.ResourceManager.Storage/README.md @@ -22,6 +22,8 @@ To create an authenticated client and start interacting with Azure resources, pl ## Key Concepts +Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) + ## Documentation Documentation is available to help you learn how to use this package @@ -46,6 +48,8 @@ Code samples for using the management library for .NET can be found in the follo ## Next steps +For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/) + ## Contributing For details on contributing to this repository, see the contributing From 41a0f0a6fbafacfa5e41fdbd792a0bc1cdaf7fdb Mon Sep 17 00:00:00 2001 From: Nick Zhu Date: Mon, 22 Jun 2020 14:50:00 +0800 Subject: [PATCH 17/20] Fix case error --- .../Azure.ResourceManager.AppConfiguration/README.md | 2 +- sdk/compute/Azure.ResourceManager.Compute/README.md | 2 +- sdk/eventhub/Azure.ResourceManager.EventHubs/README.md | 2 +- sdk/keyvault/Azure.ResourceManager.KeyVault/README.md | 2 +- sdk/network/Azure.ResourceManager.Network/README.md | 2 +- sdk/resources/Azure.ResourceManager.Resources/README.md | 2 +- sdk/storage/Azure.ResourceManager.Storage/README.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md index 159b5e941b51..859018866a68 100644 --- a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md +++ b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.AppConfiguration -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) diff --git a/sdk/compute/Azure.ResourceManager.Compute/README.md b/sdk/compute/Azure.ResourceManager.Compute/README.md index f7f5aaf1bca3..e684de84f409 100644 --- a/sdk/compute/Azure.ResourceManager.Compute/README.md +++ b/sdk/compute/Azure.ResourceManager.Compute/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.Compute -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index 7ae04b2c5995..4efd94c3ea54 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.EventHubs -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) diff --git a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md index bb65e70d87fe..5e1ca5c23de3 100644 --- a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md +++ b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.KeyVault -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) diff --git a/sdk/network/Azure.ResourceManager.Network/README.md b/sdk/network/Azure.ResourceManager.Network/README.md index 1aed455d6d31..857fe9f0c159 100644 --- a/sdk/network/Azure.ResourceManager.Network/README.md +++ b/sdk/network/Azure.ResourceManager.Network/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.Network -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index 965958b7ff88..98bbf3e24d39 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.Resources -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) diff --git a/sdk/storage/Azure.ResourceManager.Storage/README.md b/sdk/storage/Azure.ResourceManager.Storage/README.md index 9e170d918ef8..934807f1c909 100644 --- a/sdk/storage/Azure.ResourceManager.Storage/README.md +++ b/sdk/storage/Azure.ResourceManager.Storage/README.md @@ -20,7 +20,7 @@ Install-Package Azure.ResourceManager.Storage -Version 1.0.0-preview.1 To create an authenticated client and start interacting with Azure resources, please see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/mgmt_preview_quickstart.md) -## Key Concepts +## Key concepts Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html) From b0164645df9a385fd43b0e06e357e4665fcf70cc Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Mon, 22 Jun 2020 15:38:23 +0800 Subject: [PATCH 18/20] Update doc/mgmt_preview_quickstart.md Co-authored-by: erich-wang --- doc/mgmt_preview_quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md index fad203fe6791..671ac3a28db0 100644 --- a/doc/mgmt_preview_quickstart.md +++ b/doc/mgmt_preview_quickstart.md @@ -93,7 +93,7 @@ following: var resourceClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); var resourceGroupsClient = resourceClient.GetResourceGroupsClient(); ``` -From this code snippet, we showed that in order to interact with Resources, we need to create a top-level client first (**ResourcesManagementClient**), then get the corresponding sub-resource client we are interested in, in this case we called **.GetResourceGroupsClient()** to get a ResourceGroupsClient +From this code snippet, we showed that in order to interact with Resources, we need to create a top-level client first (**ResourcesManagementClient**), then get the corresponding sub-resource client we are interested in, in this case we called **.ResourceGroups** to get a ResourceGroupsOperations For more information and different authentication approaches using Azure Identity can be found in [this document](https://docs.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet) From 8a5c68552ef35fddccddee1d11b27e72e57dfe08 Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Mon, 22 Jun 2020 15:38:58 +0800 Subject: [PATCH 19/20] Update doc/mgmt_preview_quickstart.md Co-authored-by: erich-wang --- doc/mgmt_preview_quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md index 671ac3a28db0..932c824b3f18 100644 --- a/doc/mgmt_preview_quickstart.md +++ b/doc/mgmt_preview_quickstart.md @@ -91,7 +91,7 @@ following: ... var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID"); var resourceClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); - var resourceGroupsClient = resourceClient.GetResourceGroupsClient(); + var resourceGroupsClient = resourceClient.ResourceGroups; ``` From this code snippet, we showed that in order to interact with Resources, we need to create a top-level client first (**ResourcesManagementClient**), then get the corresponding sub-resource client we are interested in, in this case we called **.ResourceGroups** to get a ResourceGroupsOperations From 7a43065bf4c02a13674e33bfa12998a8ff7fe66a Mon Sep 17 00:00:00 2001 From: nickzhums <56864335+nickzhums@users.noreply.github.com> Date: Mon, 22 Jun 2020 15:44:22 +0800 Subject: [PATCH 20/20] Update doc/mgmt_preview_quickstart.md Co-authored-by: erich-wang --- doc/mgmt_preview_quickstart.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/mgmt_preview_quickstart.md b/doc/mgmt_preview_quickstart.md index 932c824b3f18..277e203f26f6 100644 --- a/doc/mgmt_preview_quickstart.md +++ b/doc/mgmt_preview_quickstart.md @@ -180,12 +180,12 @@ namespace AzureCreateVMSample var networkClient = new NetworkManagementClient(subscriptionId, new DefaultAzureCredential()); var resourcesClient = new ResourcesManagementClient(subscriptionId, new DefaultAzureCredential()); - var virtualNetworksClient = networkClient.GetVirtualNetworksClient(); - var networkInterfaceClient = networkClient.GetNetworkInterfacesClient(); - var publicIpAddressClient = networkClient.GetPublicIPAddresssesClient(); - var availabilitySetsClient = computeClient.GetAvailabilitySetsClient(); - var virtualMachinesClient = computeClient.GetVirtualMachinesClient(); - var resourceGroupClient = resourcesClient..GetResourceGroupsClient(); + var virtualNetworksClient = networkClient.VirtualNetworks; + var networkInterfaceClient = networkClient.NetworkInterfaces; + var publicIpAddressClient = networkClient.PublicIPAddressses; + var availabilitySetsClient = computeClient.AvailabilitySets; + var virtualMachinesClient = computeClient.VirtualMachines; + var resourceGroupClient = resourcesClient.ResourceGroups; // Create Resource Group var resourceGroup = new ResourceGroup(location);