Package com.azure.identity

Class EnvironmentCredentialBuilder

java.lang.Object
com.azure.identity.CredentialBuilderBase<EnvironmentCredentialBuilder>
com.azure.identity.EnvironmentCredentialBuilder
All Implemented Interfaces:
com.azure.core.client.traits.HttpTrait<EnvironmentCredentialBuilder>
public class EnvironmentCredentialBuilder extends CredentialBuilderBase<EnvironmentCredentialBuilder>
Fluent credential builder for instantiating a EnvironmentCredential.

The EnvironmentCredential is appropriate for scenarios where the application is looking to read credential information from environment variables. The credential supports service principal and user credential based authentication and requires a set of environment variables to be configured for each scenario.

Sample: Construct EnvironmentCredential

The following code sample demonstrates the creation of a EnvironmentCredential, using the EnvironmentCredentialBuilder to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.

 TokenCredential environmentCredential = new EnvironmentCredentialBuilder()
     .build();
See Also:

  • Constructor Details

    • EnvironmentCredentialBuilder

      public EnvironmentCredentialBuilder()

  • Method Details

    • authorityHost

      public EnvironmentCredentialBuilder authorityHost(String authorityHost)
      Specifies the Microsoft Entra endpoint to acquire tokens.
      Parameters:
      authorityHost - the Microsoft Entra endpoint
      Returns:
      An updated instance of this builder with the authority host set as specified.

    • executorService

      public EnvironmentCredentialBuilder 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 EnvironmentCredential build()
      Creates a new EnvironmentCredential with the current configurations.
      Returns:
      a EnvironmentCredential with the current configurations.