EnvironmentCredential Class

Definition

Enables authentication to Azure Active Directory using client secret, or username and password, details configured in the following environment variables:

VariableDescription
AZURE_TENANT_IDThe Azure Active Directory tenant(directory) ID.
AZURE_CLIENT_IDThe client(application) ID of an App Registration in the tenant.
AZURE_CLIENT_SECRETA client secret that was generated for the App Registration.
AZURE_CLIENT_CERTIFICATE_LOCATIONA path to the certificate that was generate for the App Registration.
AZURE_USERNAMEThe username, also known as upn, of an Azure Active Directory user account.
AZURE_PASSWORDThe password of the Azure Active Directory user account. Note this does not support accounts with MFA enabled.
This credential ultimately uses a ClientSecretCredential or UsernamePasswordCredential to perform the authentication using these details. Please consult the documentation of that class for more details.
public class EnvironmentCredential : Azure.Core.TokenCredential
type EnvironmentCredential = class
    inherit TokenCredential
Public Class EnvironmentCredential
Inherits TokenCredential
Inheritance
EnvironmentCredential

Constructors

EnvironmentCredential()

Creates an instance of the EnvironmentCredential class and reads client secret details from environment variables. If the expected environment variables are not found at this time, the GetToken method will return the default AccessToken when invoked.

EnvironmentCredential(TokenCredentialOptions)

Creates an instance of the EnvironmentCredential class and reads client secret details from environment variables. If the expected environment variables are not found at this time, the GetToken method will return the default AccessToken when invoked.

Methods

GetToken(TokenRequestContext, CancellationToken)

Obtains a token from the Azure Active Directory service, using the specified 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. This method is called by Azure SDK clients. It isn't intended for use in application code.

GetTokenAsync(TokenRequestContext, CancellationToken)

Obtains a token from the Azure Active Directory service, using the specified 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. This method is called by Azure SDK clients. It isn't intended for use in application code.

Applies to