Sdílet prostřednictvím


EnvironmentCredential.GetToken(TokenRequestContext, CancellationToken) Method

Definition

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 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

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

Exceptions

Thrown when the authentication failed.

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

Applies to