EnvironmentCredential Classe

Définition

Espace de noms:

Azure.Identity

Assembly:

Azure.Identity.dll

Paquet:

Azure.Identity v1.12.0

Source:

EnvironmentCredential.cs

Active l’authentification à Microsoft Entra ID à l’aide d’une clé secrète client ou d’un certificat, ou en tant qu’utilisateur avec un nom d’utilisateur et un mot de passe.

La configuration est tentée dans cet ordre, à l’aide des variables d’environnement suivantes :

Principal de service avec secret :

Variable	Description
AZURE_TENANT_ID	ID de locataire (répertoire) Microsoft Entra.
AZURE_CLIENT_ID	ID client (application) d’une inscription d’application dans le locataire.
AZURE_CLIENT_SECRET	Un secret client qui a été généré pour l’inscription de l’application.

Principal de service avec certificat :

Variable	Description
AZURE_TENANT_ID	ID de locataire (répertoire) Microsoft Entra.
AZURE_CLIENT_ID	ID client (application) d’une inscription d’application dans le locataire.
AZURE_CLIENT_CERTIFICATE_PATH	Chemin d’accès au certificat et à la paire de clés privées au format PEM ou PFX, qui peut authentifier l’inscription de l’application.
AZURE_CLIENT_CERTIFICATE_PASSWORD	(Facultatif) Mot de passe protégeant le fichier de certificat (actuellement pris en charge uniquement pour les certificats PFX (PKCS12).
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN	(Facultatif) Spécifie si une demande d’authentification inclut un en-tête x5c pour prendre en charge l’authentification basée sur le nom de l’objet/l’émetteur. Lorsqu’elles sont définies sur « true » ou « 1 », les demandes d’authentification incluent l’en-tête x5c.

Nom d’utilisateur et mot de passe :

Variable	Description
AZURE_TENANT_ID	ID de locataire (répertoire) Microsoft Entra.
AZURE_CLIENT_ID	ID client (application) d’une inscription d’application dans le locataire.
AZURE_USERNAME	Nom d’utilisateur, également appelé upn, d’un compte d’utilisateur Microsoft Entra.
AZURE_PASSWORD	Mot de passe du compte d’utilisateur Microsoft Entra. Notez que les comptes avec MFA activé ne sont pas pris en charge.

Ces informations d’identification utilisent finalement un ClientSecretCredential, ClientCertificateCredentialou UsernamePasswordCredential pour effectuer l’authentification à l’aide de ces détails. Pour plus d’informations, consultez la documentation de cette classe.

public class EnvironmentCredential : Azure.Core.TokenCredential

type EnvironmentCredential = class
    inherit TokenCredential

Public Class EnvironmentCredential
Inherits TokenCredential

Héritage

Object

TokenCredential

EnvironmentCredential

Constructeurs

EnvironmentCredential()	Crée une instance de la classe EnvironmentCredential et lit les détails de la clé secrète client à partir de variables d’environnement. Si les variables d’environnement attendues sont introuvables pour le moment, la méthode GetToken retourne la valeur par défaut AccessToken lorsqu’elle est appelée.
EnvironmentCredential(EnvironmentCredentialOptions)	Crée une instance de la classe EnvironmentCredential et lit les détails de la clé secrète client à partir de variables d’environnement. Si les variables d’environnement attendues sont introuvables pour le moment, la méthode GetToken retourne la valeur par défaut AccessToken lorsqu’elle est appelée.

Méthodes

GetToken(TokenRequestContext, CancellationToken)

Obtient un jeton à partir de l’ID de Microsoft Entra, en utilisant les détails du client spécifiés dans les variables d’environnement AZURE_TENANT_ID, AZURE_CLIENT_ID et AZURE_CLIENT_SECRET ou AZURE_USERNAME et AZURE_PASSWORD à authentifier. Les jetons acquis sont mis en cache par le instance d’informations d’identification. La durée de vie et l’actualisation des jetons sont gérées automatiquement. Si possible, réutilisez les instances d’informations d’identification pour optimiser l’efficacité du cache.

GetTokenAsync(TokenRequestContext, CancellationToken)

Obtient un jeton à partir de l’ID de Microsoft Entra, en utilisant les détails du client spécifiés dans les variables d’environnement AZURE_TENANT_ID, AZURE_CLIENT_ID et AZURE_CLIENT_SECRET ou AZURE_USERNAME et AZURE_PASSWORD à authentifier. Les jetons acquis sont mis en cache par le instance d’informations d’identification. La durée de vie et l’actualisation des jetons sont gérées automatiquement. Si possible, réutilisez les instances d’informations d’identification pour optimiser l’efficacité du cache.