TokenCredentialOptions Class

Definition

Namespace:

Azure.Identity

Assembly:

Azure.Identity.dll

Package:

Azure.Identity v1.13.1

Source:

TokenCredentialOptions.cs

Options to configure requests made to the OAUTH identity service.

public class TokenCredentialOptions : Azure.Core.ClientOptions

type TokenCredentialOptions = class
    inherit ClientOptions

Public Class TokenCredentialOptions
Inherits ClientOptions

Inheritance

Object

ClientOptions

TokenCredentialOptions

Derived

Azure.Identity.AuthorizationCodeCredentialOptions

Azure.Identity.AzureCliCredentialOptions

Azure.Identity.AzureDeveloperCliCredentialOptions

Azure.Identity.AzurePipelinesCredentialOptions

Azure.Identity.AzurePowerShellCredentialOptions

Azure.Identity.ClientAssertionCredentialOptions

Azure.Identity.ClientCertificateCredentialOptions

Azure.Identity.ClientSecretCredentialOptions

Azure.Identity.DefaultAzureCredentialOptions

Azure.Identity.DeviceCodeCredentialOptions

Azure.Identity.EnvironmentCredentialOptions

Azure.Identity.InteractiveBrowserCredentialOptions

Azure.Identity.ManagedIdentityCredentialOptions

Azure.Identity.OnBehalfOfCredentialOptions

Azure.Identity.SharedTokenCacheCredentialOptions

Azure.Identity.UsernamePasswordCredentialOptions

Azure.Identity.VisualStudioCodeCredentialOptions

Azure.Identity.VisualStudioCredentialOptions

Azure.Identity.WorkloadIdentityCredentialOptions

Constructors

TokenCredentialOptions()

Constructs a new TokenCredentialOptions instance.

Properties

AuthorityHost	The host of the Microsoft Entra authority. The default is https://login.microsoftonline.com/. For well known authority hosts for Azure cloud instances see AzureAuthorityHosts.
Diagnostics	Gets the credential diagnostic options.
IsUnsafeSupportLoggingEnabled	Gets or sets value indicating if ETW logging that contains potentially sensitive content should be logged. Setting this property to true will not disable redaction of Request Content. To enable logging of sensitive Content the IsLoggingContentEnabled property must be set to true. Setting this property to true equates to passing 'true' for the enablePiiLogging parameter to the 'WithLogging' method on the MSAL client builder.
Retry	Gets the client retry options. (Inherited from ClientOptions)
RetryPolicy	Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values. (Inherited from ClientOptions)
Transport	The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport. (Inherited from ClientOptions)

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the 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)