DeviceCodeCredential.AuthenticateAsync Method

Definition

Namespace:

Azure.Identity

Assembly:

Azure.Identity.dll

Package:

Azure.Identity v1.13.1

Overloads

AuthenticateAsync(CancellationToken)	Interactively authenticates a user via the default browser.
AuthenticateAsync(TokenRequestContext, CancellationToken)	Interactively authenticates a user via the default browser.

AuthenticateAsync(CancellationToken)

Source:

DeviceCodeCredential.cs

Interactively authenticates a user via the default browser.

public virtual System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord> AuthenticateAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member AuthenticateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>
override this.AuthenticateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>

Public Overridable Function AuthenticateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of AuthenticationRecord)

Parameters

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<AuthenticationRecord>

The AuthenticationRecord which can be used to silently authenticate the account on future execution of credentials using the same persisted token cache.

Exceptions

AuthenticationFailedException

Thrown when the authentication failed.

AuthenticateAsync(TokenRequestContext, CancellationToken)

Source:

DeviceCodeCredential.cs

Interactively authenticates a user via the default browser.

public virtual System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord> AuthenticateAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);

abstract member AuthenticateAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>
override this.AuthenticateAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Identity.AuthenticationRecord>

Public Overridable Function AuthenticateAsync (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AuthenticationRecord)

Parameters

requestContext

TokenRequestContext

The details of the authentication request.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<AuthenticationRecord>

The AuthenticationRecord of the authenticated account.

Exceptions

AuthenticationFailedException

Thrown when the authentication failed.