SharedTokenCacheCredentialOptions Class

Definition

Options to configure the SharedTokenCacheCredential authentication.

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

Constructors

SharedTokenCacheCredentialOptions()

Initializes a new instance of SharedTokenCacheCredentialOptions.

SharedTokenCacheCredentialOptions(TokenCachePersistenceOptions)

Initializes a new instance of SharedTokenCacheCredentialOptions.

Properties

AuthenticationRecord

The AuthenticationRecord captured from a previous authentication with an interactive credential, such as the InteractiveBrowserCredential or DeviceCodeCredential.

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)
ClientId

The client id of the application registration used to authenticate users in the cache.

Diagnostics

Gets the client diagnostic options.

(Inherited from ClientOptions)
EnableGuestTenantAuthentication

When set to true the SharedTokenCacheCredential can be used to authenticate to tenants other than the home tenant, requiring Username and TenantId also to be specified as well.

Retry

Gets the client retry options.

(Inherited from ClientOptions)
TenantId

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.

TokenCachePersistenceOptions

Specifies the TokenCachePersistenceOptions to be used by the credential.

Transport

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

(Inherited from ClientOptions)
Username

Specifies the preferred authentication account username, or UPN, 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.

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