| title | description | ms.date | author | ms.author | ms.reviewer | ms.topic | ms.custom | appliesto | ||
|---|---|---|---|---|---|---|---|---|---|---|
Spring Cloud Azure Redis support | This article describes how Spring Cloud Azure and Azure Redis can be used together. | 04/06/2023 | KarlErickson | karler | seal | reference | devx-track-java, devx-track-extended-java |
|
This article describes how you can use Spring Cloud Azure and Spring Data Redis together and provide various types of credentials for authentication to Azure Cache for Redis.
Azure Cache for Redis provides an in-memory data store based on the Redis software. Redis improves the performance and scalability of an application that uses backend data stores heavily.
For supported versions, see Current versions.
Passwordless connection uses Microsoft Entra authentication for connecting to Azure services without storing any credentials in the application, its configuration files, or in environment variables. Microsoft Entra authentication is a mechanism for connecting to Azure Cache for Redis using identities defined in Microsoft Entra ID. With Microsoft Entra authentication, you can manage cache identities and other Microsoft services in a central location, which simplifies permission management.
Spring Cloud Azure first builds one of the following types of credentials depending on the application authentication configuration:
ClientSecretCredentialClientCertificateCredentialUsernamePasswordCredentialManagedIdentityCredential
If none of these types of credentials are found, the credential chain via DefaultTokenCredential is used to obtain credentials from application properties, environment variables, managed identity, or IDEs. For more information, see Spring Cloud Azure authentication.
Configurable properties when using Redis support:
[!div class="mx-tdBreakAll"]
Property Description Default Value Required spring.cloud.azure.redis.enabled Whether an Azure Cache for Redis is enabled. true No spring.cloud.azure.redis.name Azure Cache for Redis instance name. Yes spring.cloud.azure.redis.resource.resource-group The resource group of Azure Cache for Redis. Yes spring.cloud.azure.profile.subscription-id The subscription ID. Yes spring.data.redis.azure.passwordless-enabled Whether to enable passwordless for Azure Cache for Redis. false No
Configurable properties when using Redis support:
[!div class="mx-tdBreakAll"]
Property Description Default Value Required spring.cloud.azure.redis.enabled Whether an Azure Cache for Redis is enabled. true No spring.cloud.azure.redis.name Azure Cache for Redis instance name. Yes spring.cloud.azure.redis.resource.resource-group The resource group of Azure Cache for Redis. Yes spring.cloud.azure.profile.subscription-id The subscription ID. Yes spring.redis.azure.passwordless-enabled Whether to enable passwordless for Azure Cache for Redis. false No
The following sections show the classic Spring Boot application usage scenarios.
Add the following dependency to your project. This automatically includes the
spring-boot-starterdependency in your project transitively.<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-starter-data-redis-lettuce</artifactId> </dependency>
[!NOTE] Passwordless connections have been supported since version
5.13.0.Remember to add the BOM
spring-cloud-azure-dependenciesalong with the above dependency. For more information, see the Getting started section of the Spring Cloud Azure developer guide.Configure the following properties in your application.yml file:
spring: data: redis: host: ${AZURE_CACHE_REDIS_HOST}username: ${AZURE_CACHE_REDIS_USERNAME}port: 6380ssl: enabled: trueazure: passwordless-enabled: true
[!IMPORTANT] Passwordless connection uses Microsoft Entra authentication. To use Microsoft Entra authentication, you should enable Microsoft Entra Authentication and select
user(managed identity/service principal)to assignData Owner Access Policy.For more information and to get the value for
username, see the Enable Microsoft Entra ID authentication on your cache section of Use Microsoft Entra ID for cache authentication.
Add the following dependency to your project. This automatically includes the
spring-boot-starterdependency in your project transitively.<dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-starter-redis</artifactId> </dependency>
[!NOTE] Passwordless connections have been supported since version
4.6.0.Remember to add the BOM
spring-cloud-azure-dependenciesalong with the above dependency. For more information, see the Getting started section of the Spring Cloud Azure developer guide.Configure the following properties in your application.yml file:
spring: redis: host: ${AZURE_CACHE_REDIS_HOST}username: ${AZURE_CACHE_REDIS_USERNAME}port: 6380ssl: trueazure: passwordless-enabled: true
[!IMPORTANT] Passwordless connection uses Microsoft Entra authentication. To use Microsoft Entra authentication, you should enable Microsoft Entra Authentication and select
user(managed identity/service principal)to assignData Owner Access Policy.For more information and to get the value for
username, see the Enable Microsoft Entra ID authentication on your cache section of Use Microsoft Entra ID for cache authentication.
To use the managed identity, you need enable the managed identity for your service and enable Microsoft Entra authentication on your cache.
Then, add the following properties in your application.yml file:
spring: cloud: azure: credential: managed-identity-enabled: true
[!IMPORTANT] The
redis.usernameshould change to the managed identity object (principal) ID.If you're using user-assigned managed identity, you also need to add the property
spring.cloud.azure.credential.client-idwith your user-assigned managed identity client ID.
Use the following steps to connect to Azure Cache for Redis:
Add the following dependency to your project. This automatically includes the
spring-boot-starterdependency in your project transitively.<dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-starter-data-redis-lettuce</artifactId> </dependency> <dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-resourcemanager</artifactId> </dependency> <dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
[!NOTE] Remember to add the BOM
spring-cloud-azure-dependenciesalong with the above dependency. For more information, see the Getting started section of the Spring Cloud Azure developer guide.
Add the following dependency to your project. This automatically includes the
spring-boot-starterdependency in your project transitively.<dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-starter</artifactId> </dependency> <dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-resourcemanager</artifactId> </dependency> <dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
[!NOTE] Remember to add the BOM
spring-cloud-azure-dependenciesalong with the above dependency. For more information, see the Getting started section of the Spring Cloud Azure developer guide.
Configure the following properties in your application.yml file:
spring: cloud: azure: profile: subscription-id: ${AZURE_SUBSCRIPTION_ID}redis: name: ${AZURE_CACHE_REDIS_NAME}resource: resource-group: ${AZURE_RESOURCE_GROUP}
See the azure-spring-boot-samples repository on GitHub.
