DefaultAzureCredential class

Provides a default ChainedTokenCredential configuration that works for most applications that use Azure SDK client libraries. For more information, see DefaultAzureCredential overview.

The following credential types will be tried, in order:

• EnvironmentCredential
• WorkloadIdentityCredential
• ManagedIdentityCredential
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• <xref:BrokerCredential>

Consult the documentation of these credential types for more information on how they attempt authentication.

The following example demonstrates how to use the requiredEnvVars option to ensure that certain environment variables are set before the DefaultAzureCredential is instantiated. If any of the specified environment variables are missing or empty, an error will be thrown, preventing the application from continuing execution without the necessary configuration. It also demonstrates how to set the AZURE_TOKEN_CREDENTIALS environment variable to control which credentials are included in the chain.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});