Skip to content

Commit dc92bf2

Browse files
authored
Polish the README and CHANGELOG files (second batch) (Azure#32935)
1 parent 1bed2b7 commit dc92bf2

File tree

451 files changed

+5176
-4234
lines changed

Some content is hidden

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

451 files changed

+5176
-4234
lines changed

eng/templates/Azure.ResourceManager.Template/src/Azure.ResourceManager.Template.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<PropertyGroup>
33
<Version>1.0.0-beta.1</Version>
44
<PackageId>Azure.ResourceManager.Template</PackageId>
5-
<Description>Azure Resource Manager client SDK for Azure resource provider ProviderFullName</Description>
5+
<Description>Azure Resource Manager client SDK for Azure resource provider ProviderFullName.</Description>
66
<PackageTags>azure;management;arm;resource manager;ProviderNameLowercase</PackageTags>
77
</PropertyGroup>
88
</Project>

sdk/advisor/Azure.ResourceManager.Advisor/CHANGELOG.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ The package name has been changed from `Microsoft.Azure.Management.Advisor` to `
2222

2323
### General New Features
2424

25-
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET
26-
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing
27-
- HTTP pipeline with custom policies
28-
- Better error-handling
29-
- Support uniform telemetry across all languages
25+
This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html), and provides many core capabilities:
3026

31-
This package follows the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet_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.
27+
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET.
28+
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
29+
- HTTP pipeline with custom policies.
30+
- Better error-handling.
31+
- Support uniform telemetry across all languages.
3232

33-
This is a Public Preview version, so expect incompatible changes in subsequent releases as we improve the product. To provide feedback, please submit an issue in our [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues).
33+
This package is a Public Preview version, so expect incompatible changes in subsequent releases as we improve the product. To provide feedback, submit an issue in our [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues).
34+
35+
> NOTE: For more information about unified authentication, please refer to [Microsoft Azure Identity documentation for .NET](https://docs.microsoft.com//dotnet/api/overview/azure/identity-readme?view=azure-dotnet).

sdk/advisor/Azure.ResourceManager.Advisor/README.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,60 @@
1-
# Azure Advisor Management client library for .NET
1+
# Microsoft Azure Advisor management client library for .NET
22

3-
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.
3+
Microsoft Advisor is a personalized cloud consultant that helps you follow best practices to optimize your Azure deployments. It analyzes your resource configuration and usage telemetry and then recommends solutions that can help you improve the cost effectiveness, performance, Reliability (formerly called High availability), and security of your Azure resources.
4+
5+
This library supports managing Microsoft Azure Advisor Configuration resources.
6+
7+
This library follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html), and provides many core capabilities:
8+
9+
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET.
10+
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
11+
- HTTP pipeline with custom policies.
12+
- Better error-handling.
13+
- Support uniform telemetry across all languages.
414

515
## Getting started
616

717
### Install the package
818

9-
Install the Azure Advisor management library for .NET with [NuGet](https://www.nuget.org/):
19+
Install the Microsoft Azure Advisor management library for .NET with [NuGet](https://www.nuget.org/):
1020

1121
```dotnetcli
1222
dotnet add package Azure.ResourceManager.Advisor --prerelease
1323
```
1424

1525
### Prerequisites
1626

17-
* You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/)
27+
* You must have an [Microsoft Azure subscription](https://azure.microsoft.com/free/dotnet/).
1828

1929
### Authenticate the Client
2030

21-
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/main/doc/dev/mgmt_quickstart.md)
31+
To create an authenticated client and start interacting with Microsoft Azure resources, see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/mgmt_quickstart.md).
2232

2333
## Key concepts
2434

25-
Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html)
35+
Key concepts of the Microsoft Azure SDK for .NET can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html).
2636

2737
## Documentation
2838

29-
Documentation is available to help you learn how to use this package
39+
Documentation is available to help you learn how to use this package:
3040

31-
- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/mgmt_quickstart.md)
32-
- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet)
33-
- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md)
41+
- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/mgmt_quickstart.md).
42+
- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet).
43+
- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md).
3444

3545
## Examples
3646

3747
Code samples for using the management library for .NET can be found in the following locations
38-
- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK)
48+
- [.NET Management Library Code Samples](https://aka.ms/azuresdk-net-mgmt-samples)
3949

4050
## Troubleshooting
4151

42-
- File an issue via [Github
43-
Issues](https://github.com/Azure/azure-sdk-for-net/issues)
44-
- Check [previous
45-
questions](https://stackoverflow.com/questions/tagged/azure+.net)
46-
or ask new ones on Stack Overflow using azure and .net tags.
47-
52+
- File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-net/issues).
53+
- Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using Azure and .NET tags.
4854

4955
## Next steps
5056

51-
For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/)
57+
For more information about Microsoft Azure SDK, see [this website](https://azure.github.io/azure-sdk/).
5258

5359
## Contributing
5460

@@ -62,13 +68,13 @@ your contribution. For details, visit <https://cla.microsoft.com>.
6268

6369
When you submit a pull request, a CLA-bot will automatically determine
6470
whether you need to provide a CLA and decorate the PR appropriately
65-
(e.g., label, comment). Simply follow the instructions provided by the
66-
bot. You will only need to do this once across all repositories using
67-
our CLA.
71+
(for example, label, comment). Follow the instructions provided by the
72+
bot. You'll only need to do this action once across all repositories
73+
using our CLA.
6874

6975
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For
70-
more information see the [Code of Conduct FAQ][coc_faq] or contact
71-
<opencode@microsoft.com> with any additional questions or comments.
76+
more information, see the [Code of Conduct FAQ][coc_faq] or contact
77+
<opencode@microsoft.com> with any other questions or comments.
7278

7379
<!-- LINKS -->
7480
[cg]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/resourcemanager/Azure.ResourceManager/docs/CONTRIBUTING.md

sdk/advisor/Azure.ResourceManager.Advisor/src/Azure.ResourceManager.Advisor.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<PropertyGroup>
33
<Version>1.0.0-beta.2</Version>
44
<PackageId>Azure.ResourceManager.Advisor</PackageId>
5-
<Description>Azure Resource Manager client SDK for Azure resource provider Advisor</Description>
5+
<Description>Microsoft Azure Resource Manager client SDK for Azure resource provider Microsoft.Advisor.</Description>
66
<PackageTags>azure;management;arm;resource manager;advisor</PackageTags>
77
</PropertyGroup>
88
</Project>

sdk/agrifood/Azure.ResourceManager.AgFoodPlatform/CHANGELOG.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ The package name has been changed from `Microsoft.Azure.Management.AgFoodPlatfor
2222

2323
### General New Features
2424

25-
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET
26-
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing
27-
- HTTP pipeline with custom policies
28-
- Better error-handling
29-
- Support uniform telemetry across all languages
25+
This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html), and provides many core capabilities:
3026

31-
This package follows the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet_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.
27+
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET.
28+
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
29+
- HTTP pipeline with custom policies.
30+
- Better error-handling.
31+
- Support uniform telemetry across all languages.
3232

33-
This is a Public Preview version, so expect incompatible changes in subsequent releases as we improve the product. To provide feedback, please submit an issue in our [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues).
33+
This package is a Public Preview version, so expect incompatible changes in subsequent releases as we improve the product. To provide feedback, submit an issue in our [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues).
34+
35+
> NOTE: For more information about unified authentication, please refer to [Microsoft Azure Identity documentation for .NET](https://docs.microsoft.com//dotnet/api/overview/azure/identity-readme?view=azure-dotnet).

sdk/agrifood/Azure.ResourceManager.AgFoodPlatform/README.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,60 @@
1-
# Azure AgFood Platform Management client library for .NET
1+
# Microsoft Azure AgFood Platform management client library for .NET
22

3-
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.
3+
Microsoft Azure AgFood Platform is a fully managed multi-tenant AgFood PaaS platform offering, targeted at AgFood tech product leaders, developers & data scientists across customers & ISVs.
4+
5+
This library supports managing Microsoft Azure AgFood Platform resources.
6+
7+
This library follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html), and provides many core capabilities:
8+
9+
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET.
10+
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
11+
- HTTP pipeline with custom policies.
12+
- Better error-handling.
13+
- Support uniform telemetry across all languages.
414

515
## Getting started
616

717
### Install the package
818

9-
Install the Azure AgFoodPlatform management library for .NET with [NuGet](https://www.nuget.org/):
19+
Install the Microsoft Azure AgFoodPlatform management library for .NET with [NuGet](https://www.nuget.org/):
1020

1121
```dotnetcli
1222
dotnet add package Azure.ResourceManager.AgFoodPlatform --prerelease
1323
```
1424

1525
### Prerequisites
1626

17-
* You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/)
27+
* You must have an [Microsoft Azure subscription](https://azure.microsoft.com/free/dotnet/).
1828

1929
### Authenticate the Client
2030

21-
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/main/doc/dev/mgmt_quickstart.md)
31+
To create an authenticated client and start interacting with Microsoft Azure resources, see the [quickstart guide here](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/mgmt_quickstart.md).
2232

2333
## Key concepts
2434

25-
Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html)
35+
Key concepts of the Microsoft Azure SDK for .NET can be found [here](https://azure.github.io/azure-sdk/dotnet_introduction.html).
2636

2737
## Documentation
2838

29-
Documentation is available to help you learn how to use this package
39+
Documentation is available to help you learn how to use this package:
3040

31-
- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/mgmt_quickstart.md)
32-
- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet)
33-
- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md)
41+
- [Quickstart](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/mgmt_quickstart.md).
42+
- [API References](https://docs.microsoft.com/dotnet/api/?view=azure-dotnet).
43+
- [Authentication](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md).
3444

3545
## Examples
3646

3747
Code samples for using the management library for .NET can be found in the following locations
38-
- [.NET Management Library Code Samples](https://docs.microsoft.com/samples/browse/?branch=master&languages=csharp&term=managing%20using%20Azure%20.NET%20SDK)
48+
- [.NET Management Library Code Samples](https://aka.ms/azuresdk-net-mgmt-samples)
3949

4050
## Troubleshooting
4151

42-
- File an issue via [Github
43-
Issues](https://github.com/Azure/azure-sdk-for-net/issues)
44-
- Check [previous
45-
questions](https://stackoverflow.com/questions/tagged/azure+.net)
46-
or ask new ones on Stack Overflow using azure and .net tags.
47-
52+
- File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-net/issues).
53+
- Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using Azure and .NET tags.
4854

4955
## Next steps
5056

51-
For more information on Azure SDK, please refer to [this website](https://azure.github.io/azure-sdk/)
57+
For more information about Microsoft Azure SDK, see [this website](https://azure.github.io/azure-sdk/).
5258

5359
## Contributing
5460

@@ -62,13 +68,13 @@ your contribution. For details, visit <https://cla.microsoft.com>.
6268

6369
When you submit a pull request, a CLA-bot will automatically determine
6470
whether you need to provide a CLA and decorate the PR appropriately
65-
(e.g., label, comment). Simply follow the instructions provided by the
66-
bot. You will only need to do this once across all repositories using
67-
our CLA.
71+
(for example, label, comment). Follow the instructions provided by the
72+
bot. You'll only need to do this action once across all repositories
73+
using our CLA.
6874

6975
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For
70-
more information see the [Code of Conduct FAQ][coc_faq] or contact
71-
<opencode@microsoft.com> with any additional questions or comments.
76+
more information, see the [Code of Conduct FAQ][coc_faq] or contact
77+
<opencode@microsoft.com> with any other questions or comments.
7278

7379
<!-- LINKS -->
7480
[cg]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/resourcemanager/Azure.ResourceManager/docs/CONTRIBUTING.md

sdk/agrifood/Azure.ResourceManager.AgFoodPlatform/src/Azure.ResourceManager.AgFoodPlatform.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<PropertyGroup>
33
<Version>1.0.0-beta.2</Version>
44
<PackageId>Azure.ResourceManager.AgFoodPlatform</PackageId>
5-
<Description>Azure Resource Manager client SDK for Azure resource provider AgFoodPlatform</Description>
5+
<Description>Microsoft Azure Resource Manager client SDK for Azure resource provider Microsoft.AgFoodPlatform.</Description>
66
<PackageTags>azure;management;arm;resource manager;agfoodplatform</PackageTags>
77
</PropertyGroup>
88
</Project>

sdk/alertsmanagement/Azure.ResourceManager.AlertsManagement/CHANGELOG.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## 1.0.0 (2022-09-19)
1414

15-
This is the first stable release of the AlertsManagement Management client library.
15+
This release is the first stable release of the AlertsManagement Management client library.
1616

1717
### Breaking Changes
1818

@@ -24,10 +24,10 @@ Polishing since last public beta release:
2424
- Corrected the format of all `ETag` type properties / parameters.
2525
- Corrected the format of all `AzureLocation` type properties / parameters.
2626
- Corrected the format of all binary type properties / parameters.
27-
- Corrected all acronyms which not follow [.Net Naming Guidelines](https://docs.microsoft.com/dotnet/standard/design-guidelines/naming-guidelines).
27+
- Corrected all acronyms that not follow [.Net Naming Guidelines](https://docs.microsoft.com/dotnet/standard/design-guidelines/naming-guidelines).
2828
- Corrected enumeration name by following [Naming Enumerations Rule](https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-classes-structs-and-interfaces#naming-enumerations).
2929
- Corrected the suffix of `DateTimeOffset` properties / parameters.
30-
- Corrected the name of interval / duration properties / parameters which end with units.
30+
- Corrected the name of interval / duration properties / parameters that end with units.
3131
- Optimized the name of some models and functions.
3232

3333
### Other Changes
@@ -47,12 +47,15 @@ The package name has been changed from `Microsoft.Azure.Management.AlertsManagem
4747

4848
### General New Features
4949

50-
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET
51-
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing
52-
- HTTP pipeline with custom policies
53-
- Better error-handling
54-
- Support uniform telemetry across all languages
50+
This package follows the [new Azure SDK guidelines](https://azure.github.io/azure-sdk/general_introduction.html), and provides many core capabilities:
5551

56-
This package follows the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet_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.
52+
- Support MSAL.NET, Azure.Identity is out of box for supporting MSAL.NET.
53+
- Support [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
54+
- HTTP pipeline with custom policies.
55+
- Better error-handling.
56+
- Support uniform telemetry across all languages.
57+
58+
This package is a Public Preview version, so expect incompatible changes in subsequent releases as we improve the product. To provide feedback, submit an issue in our [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues).
59+
60+
> NOTE: For more information about unified authentication, please refer to [Microsoft Azure Identity documentation for .NET](https://docs.microsoft.com//dotnet/api/overview/azure/identity-readme?view=azure-dotnet).
5761
58-
This is a Public Preview version, so expect incompatible changes in subsequent releases as we improve the product. To provide feedback, please submit an issue in our [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues).

0 commit comments

Comments
 (0)