Skip to content

Commit

Permalink
mgmt, update README and MIGRATION_GUIDE (Azure#16426)
Browse files Browse the repository at this point in the history
  • Loading branch information
weidongxu-microsoft authored Oct 19, 2020
1 parent 8b6d124 commit acfd54a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
9 changes: 9 additions & 0 deletions sdk/resourcemanager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,9 @@ or checkout [StackOverflow for Azure Java SDK](http://stackoverflow.com/question
An `HttpClient` implementation must exist on the classpath.
See [Include optional packages](#include-optional-packages).

Latest `azure-identity` package specifies dependency on `azure-core-http-netty` package for convenience.
If you would like to use a different `HttpClient`, please exclude `azure-core-http-netty` from `azure-identity`.

### Enabling logging

Azure SDKs for Java offer a consistent logging story to help aid in troubleshooting application errors and expedite
Expand All @@ -319,6 +322,11 @@ AzureResourceManager azure = AzureResourceManager
.withDefaultSubscription();
```

### ARM throttling

Azure Resource Manager applies throttling on the number of requests sent from client within certain span of time.
For details, please refer to [Guidance on ARM throttling][throttling].

## Next steps

## Contributing
Expand All @@ -345,4 +353,5 @@ If you would like to become an active contributor to this project please follow
[sample]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/SAMPLE.md
[design]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/DESIGN.md
[design_preview]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/DESIGN_PREVIEW.md
[throttling]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/THROTTLING.md
[reactor]: https://projectreactor.io/
5 changes: 5 additions & 0 deletions sdk/resourcemanager/docs/MIGRATION_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ For users new to the Java SDK for resource management libraries, please see the
* [Updated Maven depedencies](#updated-maven-dependencies)
* [General Changes](#general-changes)
* [Authentication](#authentication)
* [AzureResourceManager Class](#azureresourcemanager-class)
* [Customized Policy](#customized-policy)
* [Custom HTTP Client](#custom-http-client)
* [Error Handling](#error-handling)
Expand Down Expand Up @@ -73,6 +74,10 @@ Azure azure = Azure.authenticate(new File("my.azureauth")).withDefaultSubscripti

For detailed information on the benefits of using the new authentication classes, please refer to [this page](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/AUTH.md)

## AzureResourceManager Class

The `Azure` class has been renamed to `AzureResourceManager`.

## Customized Policy

Because of adopting Azure Core which is a shared library across all Azure SDKs, there is also a minor change regarding how customized policy in configured.
Expand Down

0 comments on commit acfd54a

Please sign in to comment.