Azure.Identity.DefaultAzureCredentialOptions

public class DefaultAzureCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTenantId

Options to configure the DefaultAzureCredential authentication flow and requests made to Azure Identity services.

public IList<string> AdditionallyAllowedTenants { get; }

Specifies tenants in addition to the specified TenantId for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the logged in account can access. If no value is specified for TenantId, this option will have no effect on that authentication method, and the credential will acquire tokens for any requested tenant when using that method.

public TimeSpan? CredentialProcessTimeout { get; set; }

Specifies timeout for credentials invoked via sub-process. e.g. Visual Studio, Azure CLI, Azure PowerShell.

public bool DisableInstanceDiscovery { get; set; }

public bool ExcludeAzureCliCredential { get; set; }

Specifies whether the AzureCliCredential will be excluded from the DefaultAzureCredential authentication flow.

public bool ExcludeAzureDeveloperCliCredential { get; set; }

Specifies whether the AzureDeveloperCliCredential will be excluded from the DefaultAzureCredential authentication flow.

public bool ExcludeAzurePowerShellCredential { get; set; }

Specifies whether the AzurePowerShellCredential will be excluded from the DefaultAzureCredential authentication flow.

public bool ExcludeBrokerCredential { get; set; }

Specifies whether broker authentication, via InteractiveBrowserCredential, will be attempted as part of the DefaultAzureCredential authentication flow. Note that the broker authentication flow will only be attempted if the application has a reference to the Azure.Identity.Broker package.

public bool ExcludeEnvironmentCredential { get; set; }

Specifies whether the EnvironmentCredential will be excluded from the authentication flow. Setting to true disables reading authentication details from the process' environment variables.

public bool ExcludeInteractiveBrowserCredential { get; set; }

Specifies whether the InteractiveBrowserCredential will be excluded from the DefaultAzureCredential authentication flow. Setting to true disables launching the default system browser to authenticate in development environments. The default is true.

public bool ExcludeManagedIdentityCredential { get; set; }

Specifies whether the ManagedIdentityCredential will be excluded from the DefaultAzureCredential authentication flow. Setting to true disables authenticating with managed identity endpoints.

public bool ExcludeSharedTokenCacheCredential { get; set; }

Specifies whether the SharedTokenCacheCredential will be excluded from the DefaultAzureCredential authentication flow. Setting to true disables single sign-on authentication with development tools which write to the shared token cache. The default is true.

public bool ExcludeVisualStudioCodeCredential { get; set; }

Specifies whether the VisualStudioCodeCredential will be excluded from the DefaultAzureCredential authentication flow. By default, VisualStudioCodeCredential is enabled to support SSO with VS Code on supported platforms when Azure.Identity.Broker is referenced.

public bool ExcludeVisualStudioCredential { get; set; }

Specifies whether the VisualStudioCredential will be excluded from the DefaultAzureCredential authentication flow.

public bool ExcludeWorkloadIdentityCredential { get; set; }

Specifies whether the WorkloadIdentityCredential will be excluded from the authentication flow. Setting to true disables reading authentication details from the process' environment variables.

public string InteractiveBrowserCredentialClientId { get; set; }

Specifies the client ID of the selected credential.

public string InteractiveBrowserTenantId { get; set; }

The tenant id of the user to authenticate, in the case the DefaultAzureCredential authenticates through, the InteractiveBrowserCredential. The default is null and will authenticate users to their default tenant. The value can also be set by setting the environment variable AZURE_TENANT_ID.

public string ManagedIdentityClientId { get; set; }

Specifies the client ID of a user-assigned managed identity. If this value is configured, then ManagedIdentityResourceId should not be configured.

public ResourceIdentifier ManagedIdentityResourceId { get; set; }

Specifies the resource ID of a user-assigned managed identity. If this value is configured, then ManagedIdentityClientId should not be configured.

public string SharedTokenCacheTenantId { get; set; }

Specifies the tenant ID of the preferred authentication account, to be retrieved from the shared token cache for single sign on authentication with development tools, in the case multiple accounts are found in the shared token.

public string SharedTokenCacheUsername { get; set; }

Specifies the preferred authentication account to be retrieved from the shared token cache for single sign on authentication with development tools. In the case multiple accounts are found in the shared token.

public string TenantId { get; set; }

The ID of the tenant to which the credential will authenticate by default. If not specified, the credential will authenticate to any requested tenant, and will default to the tenant to which the chosen authentication method was originally authenticated.

public string VisualStudioCodeTenantId { get; set; }

The tenant ID of the user to authenticate, in the case the DefaultAzureCredential authenticates through, the VisualStudioCodeCredential. The default is null and will authenticate users to their default tenant. The value can also be set by setting the environment variable AZURE_TENANT_ID.

public string VisualStudioTenantId { get; set; }

The tenant id of the user to authenticate, in the case the DefaultAzureCredential authenticates through, the VisualStudioCredential. The default is null and will authenticate users to their default tenant. The value can also be set by setting the environment variable AZURE_TENANT_ID.

public string WorkloadIdentityClientId { get; set; }

Specifies the client ID of the application the workload identity will authenticate.

public DefaultAzureCredentialOptions()

Initializes a new instance of the DefaultAzureCredentialOptions class.