redis.clients.authentication.entraid

Class AzureIdentityProvider

java.lang.Object

redis.clients.authentication.entraid.AzureIdentityProvider

All Implemented Interfaces:

redis.clients.authentication.core.IdentityProvider

public final class AzureIdentityProvider
extends java.lang.Object
implements redis.clients.authentication.core.IdentityProvider

AzureIdentityProvider is an implementation of the IdentityProvider interface that uses Azure's DefaultAzureCredential to obtain access tokens.

This class is designed to work with Azure's identity platform to provide authentication tokens for accessing Azure resources. It uses a DefaultAzureCredential to request tokens with specified scopes and a timeout(in milliseconds). 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 DefaultAzureCredential()).build();
 
 

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

 
 Set<String> scopes = new HashSet<>(Arrays.asList("https://redis.azure.com/.default"));
 AzureIdentityProvider provider = new AzureIdentityProvider(
      new DefaultAzureCredentialBuilder().build(), scopes, 5000);
 TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder().identityProviderConfig(()-> provider)).build();
 
 

Thread Safety: This class is thread-safe as long as the provided DefaultAzureCredential is thread-safe.

See Also:

AzureTokenAuthConfigBuilder, DefaultAzureCredentialBuilder

Constructor Summary

Constructors

Constructor and Description
AzureIdentityProvider(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.Token	requestToken()

Methods inherited from class java.lang.Object

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

Constructor Detail

AzureIdentityProvider

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

Method Detail

requestToken

public redis.clients.authentication.core.Token requestToken()

Specified by:

requestToken in interface redis.clients.authentication.core.IdentityProvider