EnvironmentCredential.GetTokenAsync Method

Definition

Namespace:

Azure.Identity

Assembly:

Azure.Identity.dll

Package:

Azure.Identity v1.13.1

Source:

EnvironmentCredential.cs

Obtains a token from Microsoft Entra ID, using the client details specified in the environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET or AZURE_USERNAME and AZURE_PASSWORD to authenticate. 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>

An AccessToken which can be used to authenticate service client calls, or a default AccessToken.

Exceptions

AuthenticationFailedException

Thrown when the authentication failed.

CredentialUnavailableException

Thrown when the credential is unavailable because the environment is not properly configured.

Remarks

If the environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET are not specified, the default AccessToken