OnBehalfOfCredential.GetTokenAsync Method

Reference

Definition

Namespace:: Azure.Identity

Assembly:: Azure.Identity.dll

Package:: Azure.Identity v1.13.1

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

Source:: OnBehalfOfCredential.cs

Source:: OnBehalfOfCredential.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.

Authenticates with Microsoft Entra ID and returns an access token if successful. 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);

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

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

Parameters

requestContext: TokenRequestContext

The details of the authentication request.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

ValueTask<AccessToken>

An AccessToken which can be used to authenticate service client calls.

Exceptions

AuthenticationFailedException

Thrown when the authentication failed.

Remarks

Caching and management of the lifespan for the AccessToken is considered the responsibility of the caller: each call should request a fresh token being requested.

Applies to

Share via