com.azure.identity

Class DefaultAzureCredentialBuilder

java.lang.Object

com.azure.identity.CredentialBuilderBase<DefaultAzureCredentialBuilder>

com.azure.identity.DefaultAzureCredentialBuilder

public class DefaultAzureCredentialBuilder
extends CredentialBuilderBase<DefaultAzureCredentialBuilder>

Fluent credential builder for instantiating a DefaultAzureCredential.

See Also:

DefaultAzureCredential

Constructor Summary

Constructors

Constructor and Description
DefaultAzureCredentialBuilder()

Method Summary

Modifier and Type	Method and Description
DefaultAzureCredentialBuilder	authorityHost(String authorityHost) Specifies the Azure Active Directory endpoint to acquire tokens.
DefaultAzureCredential	build() Creates new DefaultAzureCredential with the configured options set.
DefaultAzureCredentialBuilder	excludeAzureCliCredential() Excludes the AzureCliCredential from the DefaultAzureCredential authentication flow.
DefaultAzureCredentialBuilder	excludeEnvironmentCredential() Excludes the EnvironmentCredential from the DefaultAzureCredential authentication flow and disables reading authentication details from the process' environment variables.
DefaultAzureCredentialBuilder	excludeManagedIdentityCredential() Excludes the ManagedIdentityCredential from the DefaultAzureCredential authentication flow and disables authenticating with managed identity endpoints.
DefaultAzureCredentialBuilder	excludeSharedTokenCacheCredential() Excludes the SharedTokenCacheCredential from the DefaultAzureCredential authentication flow and disables single sign on authentication with development tools which write to the shared token cache.
DefaultAzureCredentialBuilder	executorService(ExecutorService executorService) Specifies the ExecutorService to be used to execute the authentication requests.

Methods inherited from class com.azure.identity.CredentialBuilderBase

httpClient, httpPipeline, maxRetry, proxyOptions, retryTimeout, tokenRefreshOffset

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAzureCredentialBuilder

public DefaultAzureCredentialBuilder()

Method Detail

authorityHost

public DefaultAzureCredentialBuilder authorityHost(String authorityHost)

Specifies the Azure Active Directory endpoint to acquire tokens.

Parameters:

authorityHost - the Azure Active Directory endpoint

Returns:

An updated instance of this builder with the authority host set as specified.

excludeEnvironmentCredential

public DefaultAzureCredentialBuilder excludeEnvironmentCredential()

Excludes the EnvironmentCredential from the DefaultAzureCredential authentication flow and disables reading authentication details from the process' environment variables.

Returns:

An updated instance of this builder with the Environment credential exclusion set as specified.

excludeManagedIdentityCredential

public DefaultAzureCredentialBuilder excludeManagedIdentityCredential()

Excludes the ManagedIdentityCredential from the DefaultAzureCredential authentication flow and disables authenticating with managed identity endpoints.

Returns:

An updated instance of this builder with the Managed Identity credential exclusion set as specified.

excludeSharedTokenCacheCredential

public DefaultAzureCredentialBuilder excludeSharedTokenCacheCredential()

Excludes the SharedTokenCacheCredential from the DefaultAzureCredential authentication flow and disables single sign on authentication with development tools which write to the shared token cache.

Returns:

An updated instance of this builder with the Shared Token Cache credential exclusion set as specified.

excludeAzureCliCredential

public DefaultAzureCredentialBuilder excludeAzureCliCredential()

Excludes the AzureCliCredential from the DefaultAzureCredential authentication flow.

Returns:

An updated instance of this builder with the Azure Cli credential exclusion set as specified.

executorService

public DefaultAzureCredentialBuilder executorService(ExecutorService executorService)

Specifies the ExecutorService to be used to execute the authentication requests. Developer is responsible for maintaining the lifecycle of the ExecutorService.

If this is not configured, the ForkJoinPool.commonPool() will be used which is also shared with other application tasks. If the common pool is heavily used for other tasks, authentication requests might starve and setting up this executor service should be considered.

The executor service and can be safely shutdown if the TokenCredential is no longer being used by the Azure SDK clients and should be shutdown before the application exits.

Parameters:

executorService - the executor service to use for executing authentication requests.

Returns:

An updated instance of this builder with the executor service set as specified.

build

public DefaultAzureCredential build()

Creates new DefaultAzureCredential with the configured options set.

Returns:

a DefaultAzureCredential with the current configurations.