DefaultAzureCredential.GetToken Method

Reference

Definition

Namespace:: Azure.Identity

Assembly:: Azure.Identity.dll

Package:: Azure.Identity v1.11.2

Package:: Azure.Identity v1.12.0-beta.1

Source:: DefaultAzureCredential.cs

Source:: DefaultAzureCredential.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sequentially calls GetToken(TokenRequestContext, CancellationToken) on all the included credentials in the order EnvironmentCredential, ManagedIdentityCredential, SharedTokenCacheCredential, and InteractiveBrowserCredential returning the first successfully obtained AccessToken. Acquired tokens are cached by the credential instance. Token lifetime and refreshing is handled automatically. Where possible, reuse credential instances to optimize cache effectiveness.

public override Azure.Core.AccessToken GetToken (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);

override this.GetToken : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Core.AccessToken

Public Overrides Function GetToken (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As AccessToken

Parameters

requestContext: TokenRequestContext

The details of the authentication request.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

AccessToken

The first AccessToken returned by the specified sources. Any credential which raises a CredentialUnavailableException will be skipped.

Remarks

Note that credentials requiring user interaction, such as the InteractiveBrowserCredential, are not included by default.

Applies to