redis.clients.authentication.entraid

Class AzureIdentityProviderConfig

java.lang.Object

redis.clients.authentication.entraid.AzureIdentityProviderConfig

All Implemented Interfaces:

redis.clients.authentication.core.IdentityProviderConfig

public final class AzureIdentityProviderConfig
extends java.lang.Object
implements redis.clients.authentication.core.IdentityProviderConfig

Configuration class for Azure Identity Provider. This class implements the IdentityProviderConfig interface and provides a configuration for creating an AzureIdentityProvider instance.

This class uses DefaultAzureCredential for authentication and allows specifying scopes and a timeout(in milliseconds) for the identity provider.

For most cases you will not need to use it directly since AzureTokenAuthConfigBuilder will do the work for you as shown in the example below:

 
 TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder()
          .defaultAzureCredential(new DefaultAzureCredentialBuilder()).build();
  
 

In you case you need your own implementation for relevant reasons, you can use it as follows:

 
 DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
 Set<String> scopes = Set.of("https://redis.azure.com/.default");
 AzureIdentityProviderConfig azureIDPConfig = new AzureIdentityProviderConfig(credential, scopes, 5000);
 TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder().identityProviderConfig(azureIDPConfig).build();
 
 

For more information and details on how to use, please see: https://github.com/redis/jedis/blob/master/docs/advanced-usage.md#token-based-authentication https://github.com/redis/lettuce/blob/main/docs/user-guide/connecting-redis.md#microsoft-entra-id-authentication

See Also:

IdentityProviderConfig, AzureIdentityProvider, DefaultAzureCredential

Constructor Summary

Constructors

Constructor and Description
AzureIdentityProviderConfig(com.azure.identity.DefaultAzureCredential defaultAzureCredential, java.util.Set<java.lang.String> scopes, int timeout)

Method Summary

Modifier and Type	Method and Description
redis.clients.authentication.core.IdentityProvider	getProvider()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AzureIdentityProviderConfig

public AzureIdentityProviderConfig(com.azure.identity.DefaultAzureCredential defaultAzureCredential,
                                   java.util.Set<java.lang.String> scopes,
                                   int timeout)

Method Detail

getProvider

public redis.clients.authentication.core.IdentityProvider getProvider()

Specified by:

getProvider in interface redis.clients.authentication.core.IdentityProviderConfig