DefaultAzureCredential.GetTokenAsync Method

Reference

Definition

Namespace:: Azure.Identity

Assembly:: Azure.Identity.dll

Package:: Azure.Identity v1.12.0

Package:: Azure.Identity v1.13.0-beta.2

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, 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 System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);

override this.GetTokenAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>

Public Overrides Function GetTokenAsync (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of AccessToken)

Parameters

requestContext: TokenRequestContext

The details of the authentication request.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

ValueTask<AccessToken>

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

Exceptions

AuthenticationFailedException

Thrown when the authentication failed.

Remarks

Credentials requiring user interaction, such as InteractiveBrowserCredential, are excluded by default.

Applies to

Share via