Package com.azure.identity

Class EnvironmentCredential

java.lang.Object
com.azure.identity.EnvironmentCredential
All Implemented Interfaces:
com.azure.core.credential.TokenCredential
public class EnvironmentCredential extends Object implements com.azure.core.credential.TokenCredential

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.

The required environment variables for service principal authentication using client secret are as follows:

  • AZURE_CLIENT_ID
  • AZURE_CLIENT_SECRET
  • AZURE_TENANT_ID

The required environment variables for service principal authentication using client certificate are as follows:

  • AZURE_CLIENT_ID
  • AZURE_CLIENT_CERTIFICATE_PATH
  • AZURE_CLIENT_CERTIFICATE_PASSWORD
  • AZURE_TENANT_ID

The required environment variables for username password authentication are as follows:

  • AZURE_CLIENT_ID
  • AZURE_USERNAME
  • AZURE_PASSWORD
  • AZURE_TENANT_ID

The credential looks for authentication scenarios in the order above, so ensure that only targeted authentication scenario's environment variables are configured.

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:

  • Method Details

    • getToken

      public Mono<com.azure.core.credential.AccessToken> getToken(com.azure.core.credential.TokenRequestContext request)
      Specified by:
      getToken in interface com.azure.core.credential.TokenCredential

    • getTokenSync

      public com.azure.core.credential.AccessToken getTokenSync(com.azure.core.credential.TokenRequestContext request)
      Specified by:
      getTokenSync in interface com.azure.core.credential.TokenCredential