Partager via

EnvironmentCredential class

  • Référence
Paquet:
@azure/identity

Active l’authentification auprès de 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.

Constructeurs

EnvironmentCredential(EnvironmentCredentialOptions)

Crée une instance de la classe EnvironmentCredential et détermine les informations d’identification à utiliser en fonction des variables d’environnement disponibles.

Variables d’environnement requises :

  • AZURE_TENANT_ID: ID du locataire Microsoft Entra (répertoire).
  • AZURE_CLIENT_ID: ID client (application) d’une inscription d’application dans le locataire.

Si vous définissez le AZURE_TENANT_ID, vous pouvez également définir les locataires autorisés supplémentaires

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons avec une seule chaîne délimitée par des points-virgules. Utilisez * pour autoriser tous les locataires.

Variables d’environnement utilisées pour l’authentification des informations d’identification du client :

  • AZURE_CLIENT_SECRET: clé secrète client générée pour l’inscription d’application.
  • AZURE_CLIENT_CERTIFICATE_PATH: chemin d’accès à un certificat PEM à utiliser pendant l’authentification, au lieu de la clé secrète client.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (facultatif) mot de passe pour le fichier de certificat.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (facultatif) indique que la chaîne de certificats doit être définie dans l’en-tête x5c pour prendre en charge l’authentification basée sur le nom de l’objet/l’émetteur.

Les utilisateurs peuvent également fournir des variables d’environnement pour l’authentification par nom d’utilisateur et mot de passe :

  • AZURE_USERNAME: nom d’utilisateur à authentifier.
  • AZURE_PASSWORD: mot de passe à authentifier.

Si les variables d’environnement requises pour effectuer l’authentification sont manquantes, une CredentialUnavailableError est levée. Si l’authentification échoue ou s’il existe une erreur inconnue, une AuthenticationError est levée.

Méthodes

getToken(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite.

Détails du constructeur

EnvironmentCredential(EnvironmentCredentialOptions)

Crée une instance de la classe EnvironmentCredential et détermine les informations d’identification à utiliser en fonction des variables d’environnement disponibles.

Variables d’environnement requises :

  • AZURE_TENANT_ID: ID du locataire Microsoft Entra (répertoire).
  • AZURE_CLIENT_ID: ID client (application) d’une inscription d’application dans le locataire.

Si vous définissez le AZURE_TENANT_ID, vous pouvez également définir les locataires autorisés supplémentaires

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons avec une seule chaîne délimitée par des points-virgules. Utilisez * pour autoriser tous les locataires.

Variables d’environnement utilisées pour l’authentification des informations d’identification du client :

  • AZURE_CLIENT_SECRET: clé secrète client générée pour l’inscription d’application.
  • AZURE_CLIENT_CERTIFICATE_PATH: chemin d’accès à un certificat PEM à utiliser pendant l’authentification, au lieu de la clé secrète client.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (facultatif) mot de passe pour le fichier de certificat.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (facultatif) indique que la chaîne de certificats doit être définie dans l’en-tête x5c pour prendre en charge l’authentification basée sur le nom de l’objet/l’émetteur.

Les utilisateurs peuvent également fournir des variables d’environnement pour l’authentification par nom d’utilisateur et mot de passe :

  • AZURE_USERNAME: nom d’utilisateur à authentifier.
  • AZURE_PASSWORD: mot de passe à authentifier.

Si les variables d’environnement requises pour effectuer l’authentification sont manquantes, une CredentialUnavailableError est levée. Si l’authentification échoue ou s’il existe une erreur inconnue, une AuthenticationError est levée.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Paramètres

options
EnvironmentCredentialOptions

Options de configuration du client qui effectue la demande d’authentification.

Détails de la méthode

getToken(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Paramètres

scopes

string | string[]

Liste des étendues auxquelles le jeton aura accès.

options
GetTokenOptions

Paramètres facultatifs. Consultez GetTokenOptions.

Retours

Promise<AccessToken>