|  | 
|  | 1 | +# Azure Resource Manager Redis client library for Java | 
|  | 2 | + | 
|  | 3 | +Azure Resource Manager Redis client library for Java. | 
|  | 4 | + | 
|  | 5 | +This package contains Microsoft Azure SDK for Redis Management SDK. REST API for Azure Redis Cache Service. Package tag package-2021-06. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt). | 
|  | 6 | + | 
|  | 7 | +## We'd love to hear your feedback | 
|  | 8 | + | 
|  | 9 | +We're always working on improving our products and the way we communicate with our users. So we'd love to learn what's working and how we can do better. | 
|  | 10 | + | 
|  | 11 | +If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together. | 
|  | 12 | + | 
|  | 13 | +Thank you in advance for your collaboration. We really appreciate your time! | 
|  | 14 | + | 
|  | 15 | +## Documentation | 
|  | 16 | + | 
|  | 17 | +Various documentation is available to help you get started | 
|  | 18 | + | 
|  | 19 | +- [API reference documentation][docs] | 
|  | 20 | + | 
|  | 21 | +## Getting started | 
|  | 22 | + | 
|  | 23 | +### Prerequisites | 
|  | 24 | + | 
|  | 25 | +- [Java Development Kit (JDK)][jdk] with version 8 or above | 
|  | 26 | +- [Azure Subscription][azure_subscription] | 
|  | 27 | + | 
|  | 28 | +### Adding the package to your product | 
|  | 29 | + | 
|  | 30 | +[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-redis-generated;current}) | 
|  | 31 | +```xml | 
|  | 32 | +<dependency> | 
|  | 33 | +    <groupId>com.azure.resourcemanager</groupId> | 
|  | 34 | +    <artifactId>azure-resourcemanager-redis-generated</artifactId> | 
|  | 35 | +    <version>1.0.0-beta.1</version> | 
|  | 36 | +</dependency> | 
|  | 37 | +``` | 
|  | 38 | +[//]: # ({x-version-update-end}) | 
|  | 39 | + | 
|  | 40 | +### Include the recommended packages | 
|  | 41 | + | 
|  | 42 | +Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client. | 
|  | 43 | + | 
|  | 44 | +[Azure Identity][azure_identity] package and [Azure Core Netty HTTP][azure_core_http_netty] package provide the default implementation. | 
|  | 45 | + | 
|  | 46 | +### Authentication | 
|  | 47 | + | 
|  | 48 | +By default, Azure Active Directory token authentication depends on correct configure of following environment variables. | 
|  | 49 | + | 
|  | 50 | +- `AZURE_CLIENT_ID` for Azure client ID. | 
|  | 51 | +- `AZURE_TENANT_ID` for Azure tenant ID. | 
|  | 52 | +- `AZURE_CLIENT_SECRET` or `AZURE_CLIENT_CERTIFICATE_PATH` for client secret or client certificate. | 
|  | 53 | + | 
|  | 54 | +In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`. | 
|  | 55 | + | 
|  | 56 | +With above configuration, `azure` client can be authenticated by following code: | 
|  | 57 | + | 
|  | 58 | +```java | 
|  | 59 | +AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE); | 
|  | 60 | +TokenCredential credential = new DefaultAzureCredentialBuilder() | 
|  | 61 | +    .authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint()) | 
|  | 62 | +    .build(); | 
|  | 63 | +RedisManager manager = RedisManager | 
|  | 64 | +    .authenticate(credential, profile); | 
|  | 65 | +``` | 
|  | 66 | + | 
|  | 67 | +The sample code assumes global Azure. Please change `AzureEnvironment.AZURE` variable if otherwise. | 
|  | 68 | + | 
|  | 69 | +See [Authentication][authenticate] for more options. | 
|  | 70 | + | 
|  | 71 | +## Key concepts | 
|  | 72 | + | 
|  | 73 | +See [API design][design] for general introduction on design and key concepts on Azure Management Libraries. | 
|  | 74 | + | 
|  | 75 | +## Examples | 
|  | 76 | + | 
|  | 77 | +[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/redis/azure-resourcemanager-redis-generated/SAMPLE.md) | 
|  | 78 | + | 
|  | 79 | + | 
|  | 80 | +## Troubleshooting | 
|  | 81 | + | 
|  | 82 | +## Next steps | 
|  | 83 | + | 
|  | 84 | +## Contributing | 
|  | 85 | + | 
|  | 86 | +For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md). | 
|  | 87 | + | 
|  | 88 | +1. Fork it | 
|  | 89 | +1. Create your feature branch (`git checkout -b my-new-feature`) | 
|  | 90 | +1. Commit your changes (`git commit -am 'Add some feature'`) | 
|  | 91 | +1. Push to the branch (`git push origin my-new-feature`) | 
|  | 92 | +1. Create new Pull Request | 
|  | 93 | + | 
|  | 94 | +<!-- LINKS --> | 
|  | 95 | +[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS | 
|  | 96 | +[docs]: https://azure.github.io/azure-sdk-for-java/ | 
|  | 97 | +[jdk]: https://docs.microsoft.com/java/azure/jdk/ | 
|  | 98 | +[azure_subscription]: https://azure.microsoft.com/free/ | 
|  | 99 | +[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity | 
|  | 100 | +[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core-http-netty | 
|  | 101 | +[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/AUTH.md | 
|  | 102 | +[design]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/DESIGN.md | 
0 commit comments