DefaultAzureCredentialOptions Class

Definition

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

public class DefaultAzureCredentialOptions : Azure.Identity.TokenCredentialOptions
type DefaultAzureCredentialOptions = class
    inherit TokenCredentialOptions
Public Class DefaultAzureCredentialOptions
Inherits TokenCredentialOptions
Inheritance
DefaultAzureCredentialOptions

Constructors

DefaultAzureCredentialOptions()

Properties

AuthorityHost

The host of the Azure Active Directory authority. The default is https://login.microsoftonline.com/. For well known authority hosts for Azure cloud instances see AzureAuthorityHosts.

(Inherited from TokenCredentialOptions)
Diagnostics

Gets the client diagnostic options.

(Inherited from ClientOptions)
ExcludeAzureCliCredential

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

ExcludeEnvironmentCredential

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

ExcludeInteractiveBrowserCredential

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.

ExcludeManagedIdentityCredential

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

ExcludeSharedTokenCacheCredential

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.

ExcludeVisualStudioCodeCredential

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

ExcludeVisualStudioCredential

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

InteractiveBrowserTenantId

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.

ManagedIdentityClientId

Specifies the client id of the azure ManagedIdentity in the case of user assigned identity.

Retry

Gets the client retry options.

(Inherited from ClientOptions)
SharedTokenCacheTenantId

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.

SharedTokenCacheUsername

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.

Transport

The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport.

(Inherited from ClientOptions)
VisualStudioCodeTenantId

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.

VisualStudioTenantId

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.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object.

(Inherited from ClientOptions)

Applies to