@azure/identity package

  • Référence

Classes

AggregateAuthenticationError

Fournit un errors tableau contenant authenticationError instance pour les échecs d’authentification à partir d’informations d’identification dans un ChainedTokenCredential.
AuthenticationError

Fournit des détails sur un échec de l’authentification auprès d’Azure Active Directory. Le errorResponse champ contient plus de détails sur l’échec spécifique.
AuthenticationRequiredError

Erreur utilisée pour appliquer l’authentification après avoir tenté de récupérer un jeton en mode silencieux.
AuthorizationCodeCredential

Permet l’authentification pour Microsoft Entra ID à l’aide d’un code d’autorisation obtenu via le flux de code d’autorisation, décrit plus en détail dans la documentation Microsoft Entra ID :

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
AzureCliCredential

Ces informations d’identification utilisent les informations de connexion de l’utilisateur actuellement connecté via l’outil de ligne de commande Azure CLI ('az'). Pour ce faire, il lit le jeton d’accès utilisateur et l’heure d’expiration avec la commande Azure CLI « az account get-access-token ».
AzureDeveloperCliCredential

Azure Developer CLI est un outil d’interface en ligne de commande qui permet aux développeurs de créer, gérer et déployer des ressources dans Azure. Il s’appuie sur Azure CLI et fournit des fonctionnalités supplémentaires spécifiques aux développeurs Azure. Il permet aux utilisateurs de s’authentifier en tant qu’utilisateur et/ou principal de service auprès de Microsoft Entra ID. AzureDeveloperCliCredential s’authentifie dans un environnement de développement et acquiert un jeton pour le compte de l’utilisateur ou du principal de service connecté dans le Azure Developer CLI. Il agit en tant qu’utilisateur ou principal de service connecté Azure Developer CLI et exécute une commande Azure CLI en dessous pour authentifier l’application par rapport à Microsoft Entra ID.

Configurer AzureDeveloperCliCredential

Pour utiliser ces informations d’identification, le développeur doit s’authentifier localement dans Azure Developer CLI à l’aide de l’une des commandes ci-dessous :

  1. Exécutez « azd auth login » dans Azure Developer CLI pour vous authentifier de manière interactive en tant qu’utilisateur.
  2. Exécutez « azd auth login --client-id clientID --client-secret clientSecret --tenant-id tenantID » pour vous authentifier en tant que principal de service.

Vous devrez peut-être répéter ce processus au bout d’un certain temps, en fonction de la validité du jeton d’actualisation dans votre organisation. En règle générale, la période de validité du jeton d’actualisation est de quelques semaines à quelques mois. AzureDeveloperCliCredential vous invite à vous reconnecter.
AzurePowerShellCredential

Ces informations d’identification utilisent les informations utilisateur actuellement connectées du module Azure PowerShell. Pour ce faire, il lit le jeton d’accès utilisateur et l’heure d’expiration avec Azure PowerShell commandeGet-AzAccessToken -ResourceUrl {ResourceScope}
ChainedTokenCredential

Permet d’essayer plusieurs TokenCredential implémentations dans l’ordre jusqu’à ce que l’une des méthodes getToken retourne un jeton d’accès.
ClientAssertionCredential

Authentifie un principal de service avec une assertion JWT.
ClientCertificateCredential

Active l’authentification pour Microsoft Entra ID à l’aide d’un certificat encodé pem qui est affecté à une inscription d’application. Vous trouverez plus d’informations sur la configuration de l’authentification par certificat ici :

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad
ClientSecretCredential

Active l’authentification pour Microsoft Entra ID à l’aide d’une clé secrète client qui a été générée pour une inscription d’application. Vous trouverez plus d’informations sur la configuration d’une clé secrète client ici :

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
CredentialUnavailableError

Cela signifie que les informations d’identification qui ont été essayées dans des informations d’identification chaînées n’étaient pas disponibles pour être utilisées comme informations d’identification. Au lieu de traiter cela comme une erreur qui devrait arrêter la chaîne, elle est interceptée et la chaîne continue
DefaultAzureCredential

Fournit une configuration ChainedTokenCredential par défaut qui doit fonctionner pour la plupart des applications qui utilisent le Kit de développement logiciel (SDK) Azure.
DeviceCodeCredential

Active l’authentification pour Microsoft Entra ID à l’aide d’un code d’appareil que l’utilisateur peut entrer dans https://microsoft.com/devicelogin.
EnvironmentCredential

Active l’authentification pour 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.
InteractiveBrowserCredential

Active l’authentification pour Microsoft Entra ID à l’intérieur du navigateur web à l’aide du flux de connexion interactif.
ManagedIdentityCredential

Tente l’authentification à l’aide d’une identité managée disponible dans l’environnement de déploiement. Ce type d’authentification fonctionne dans les machines virtuelles Azure, les instances App Service, les applications Azure Functions, Azure Kubernetes Services, les instances Azure Service Fabric et à l’intérieur du Cloud Shell Azure.

Vous trouverez plus d’informations sur la configuration des identités managées ici : https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview
OnBehalfOfCredential

Active l’authentification pour Microsoft Entra ID à l’aide du flux On Behalf Of.
UsernamePasswordCredential

Active l’authentification pour Microsoft Entra ID avec le nom d’utilisateur et le mot de passe d’un utilisateur. Ces informations d’identification nécessitent un degré de confiance élevé. Vous ne devez donc les utiliser que lorsque d’autres types d’informations d’identification plus sécurisés ne peuvent pas être utilisés.
VisualStudioCodeCredential

Se connecte à Azure à l’aide des informations d’identification fournies par l’extension VSCode « Compte Azure ». Une fois que l’utilisateur s’est connecté via l’extension, ces informations d’identification peuvent partager le même jeton d’actualisation mis en cache par l’extension.

Il est connu que ces informations d’identification ne fonctionnent pas avec les versions d’extension de compte Azure plus récentes que 0.9.11. Une solution à long terme à ce problème est en cours. En attendant, envisagez de vous authentifier auprès d’AzureCliCredential.
WorkloadIdentityCredential

L’authentification d’identité de charge de travail est une fonctionnalité d’Azure qui permet aux applications s’exécutant sur des machines virtuelles d’accéder à d’autres ressources Azure sans avoir besoin d’un principal de service ou d’une identité managée. Avec l’authentification d’identité de charge de travail, les applications s’authentifient à l’aide de leur propre identité, plutôt que d’utiliser un principal de service partagé ou une identité managée. Sous le capot, l’authentification d’identité de charge de travail utilise le concept d’informations d’identification du compte de service (SAC), qui sont automatiquement créées par Azure et stockées de manière sécurisée dans la machine virtuelle. En utilisant l’authentification d’identité de charge de travail, vous pouvez éviter d’avoir à gérer et à faire pivoter des principaux de service ou des identités managées pour chaque application sur chaque machine virtuelle. En outre, étant donné que les sacs sont créés automatiquement et gérés par Azure, vous n’avez pas besoin de vous soucier du stockage et de la sécurisation des informations d’identification sensibles elles-mêmes. WorkloadIdentityCredential prend en charge l’authentification ID de charge de travail Microsoft Entra sur Azure Kubernetes et acquiert un jeton à l’aide des sacs disponibles dans l’environnement Azure Kubernetes. Pour plus d’informations, reportez-vous à ID de charge de travail Microsoft Entra.

Interfaces

AccessToken

Représente un jeton d’accès avec une heure d’expiration.
AuthenticationRecord

Enregistrement à utiliser pour rechercher les jetons mis en cache dans le cache.
AuthenticationRequiredErrorOptions

Paramètres facultatifs pour AuthenticationRequiredError
AuthorityValidationOptions

Fournit des options pour configurer la façon dont la bibliothèque d’identités effectue la validation de l’autorité lors des demandes d’authentification à Microsoft Entra ID.
AuthorizationCodeCredentialOptions

Options pour l’objet AuthorizationCodeCredential
AzureCliCredentialOptions

Options pour AzureCliCredential
AzureDeveloperCliCredentialOptions

Options pour AzureDeveloperCliCredential
AzurePowerShellCredentialOptions

Options pour AzurePowerShellCredential
BrokerAuthOptions

Options de configuration pour InteractiveBrowserCredential pour prendre en charge l’authentification BROKER WAM.
BrokerDisabledOptions

Paramètres lorsque l’authentification du répartiteur WAM est désactivée.
BrokerEnabledOptions

Paramètres lorsque l’authentification du répartiteur WAM est activée.
BrowserCustomizationOptions

Options de configuration partagées pour la personnalisation du navigateur
ClientAssertionCredentialOptions

Options pour clientAssertionCredential
ClientCertificateCredentialOptions

Paramètres facultatifs pour la classe ClientCertificateCredential .
ClientCertificatePEMCertificate

Options de configuration requises pour clientCertificateCredential, avec le contenu de chaîne d’un certificat PEM
ClientCertificatePEMCertificatePath

Options de configuration requises pour clientCertificateCredential, avec le chemin d’accès à un certificat PEM.
ClientSecretCredentialOptions

Paramètres facultatifs pour la classe ClientSecretCredential .
CredentialPersistenceOptions

Options de configuration partagées pour les informations d’identification qui prennent en charge la mise en cache permanente des jetons.
DefaultAzureCredentialClientIdOptions

Fournit des options pour configurer la classe DefaultAzureCredential . Cette variante prend en charge managedIdentityClientId et non managedIdentityResourceId, car une seule des deux est prise en charge.
DefaultAzureCredentialOptions

Fournit des options pour configurer la classe DefaultAzureCredential .
DefaultAzureCredentialResourceIdOptions

Fournit des options pour configurer la classe DefaultAzureCredential . Cette variante prend en charge managedIdentityResourceId et non managedIdentityClientId, car une seule des deux est prise en charge.
DeviceCodeCredentialOptions

Définit les options de la classe InteractiveBrowserCredential pour Node.js.
DeviceCodeInfo

Fournit le code utilisateur et l’URI de vérification où le code doit être entré. Fournit également un message à afficher à l’utilisateur qui contient une instruction avec ces détails.
EnvironmentCredentialOptions

Active l’authentification pour Microsoft Entra ID en fonction des variables d’environnement disponibles. Définit les options de la classe EnvironmentCredential.
ErrorResponse

Pour plus d’informations, consultez la documentation officielle :

https://learn.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code#error-response-1

REMARQUE : Cette documentation concerne la prise en charge d’OAuth v1, mais les mêmes détails de réponse d’erreur s’appliquent toujours à v2.
GetTokenOptions

Définit les options pour TokenCredential.getToken.
InteractiveBrowserCredentialInBrowserOptions

Définit les options courantes pour la classe InteractiveBrowserCredential.
InteractiveBrowserCredentialNodeOptions

Définit les options courantes pour la classe InteractiveBrowserCredential.
InteractiveCredentialOptions

Options de constructeur courantes pour les informations d’identification d’identité qui nécessitent l’interaction de l’utilisateur.
ManagedIdentityCredentialClientIdOptions

Options à envoyer sur le constructeur ManagedIdentityCredential . Cette variante prend en charge clientId et non resourceId, car une seule des deux est prise en charge.
ManagedIdentityCredentialResourceIdOptions

Options à envoyer sur le constructeur ManagedIdentityCredential . Cette variante prend en charge resourceId et non clientId, car une seule des deux est prise en charge.
MultiTenantTokenCredentialOptions

Options pour les applications multilocataires qui autorisent des locataires supplémentaires autorisés.
OnBehalfOfCredentialCertificateOptions

Définit les paramètres pour authentifier l’onBehalfOfCredential avec un certificat.
OnBehalfOfCredentialSecretOptions

Définit les paramètres pour authentifier l’onBehalfOfCredential avec un secret.
TokenCachePersistenceOptions

Paramètres qui activent la persistance du cache de jetons dans les informations d’identification d’identité.
TokenCredential

Représente des informations d’identification capables de fournir un jeton d’authentification.
TokenCredentialOptions

Fournit des options pour configurer la façon dont la bibliothèque d’identités effectue des demandes d’authentification pour Microsoft Entra ID.
UsernamePasswordCredentialOptions

Définit les options de la classe UsernamePasswordCredential .
VisualStudioCodeCredentialOptions

Fournit des options pour configurer les informations d’identification Visual Studio Code.
WorkloadIdentityCredentialOptions

Options pour la charge de travailIdentityCredential

Alias de type

BrokerOptions

Paramètres qui activent l’authentification du broker WAM dans InteractiveBrowserCredential.
BrowserLoginStyle

(Fonctionnalité de navigateur uniquement) « Style de connexion » à utiliser dans le flux d’authentification :

  • « redirection » redirige l’utilisateur vers la page d’authentification, puis le redirige vers la page une fois l’authentification terminée.
  • « popup » ouvre une nouvelle fenêtre de navigateur à l’aide de laquelle le flux de redirection est lancé. La fenêtre de navigateur existante de l’utilisateur ne quitte pas la page active
ClientCertificateCredentialPEMConfiguration

Options de configuration requises pour le ClientCertificateCredential, avec le contenu de chaîne d’un certificat PEM ou le chemin d’accès à un certificat PEM.
DeviceCodePromptCallback

Définit la signature d’un rappel qui sera passé à DeviceCodeCredential dans le but d’afficher les détails d’authentification à l’utilisateur.
IdentityPlugin

Type d’un plug-in Azure Identity, une fonction acceptant un contexte de plug-in.
OnBehalfOfCredentialOptions

Paramètres facultatifs pour la classe OnBehalfOfCredential .

Énumérations

AzureAuthorityHosts

Liste des hôtes d’autorité Azure connus

Fonctions

deserializeAuthenticationRecord(string)

Désérialise un enregistrement d’authentification sérialisé d’une chaîne dans un objet.

La chaîne d’entrée doit contenir les propriétés suivantes :

  • « autorité »
  • « homeAccountId »
  • « clientId »
  • « tenantId »
  • « nom d’utilisateur »
  • « version »

Si la version que nous recevons n’est pas prise en charge, une erreur est générée.

Pour le moment, la seule version disponible est : « 1.0 », qui est toujours définie lorsque l’enregistrement d’authentification est sérialisé.
getDefaultAzureCredential()

Retourne une nouvelle instance de DefaultAzureCredential.
serializeAuthenticationRecord(AuthenticationRecord)

Sérialise un AuthenticationRecord dans une chaîne.

La sortie d’un enregistrement d’authentification sérialisé contient les propriétés suivantes :

  • « autorité »
  • « homeAccountId »
  • « clientId »
  • « tenantId »
  • « nom d’utilisateur »
  • « version »

Pour convertir ultérieurement cette chaîne en une chaîne sérialisée AuthenticationRecord, utilisez la fonction deserializeAuthenticationRecord()exportée .
useIdentityPlugin(IdentityPlugin)

Étendez Azure Identity avec des fonctionnalités supplémentaires. Passez un plug-in à partir d’un package de plug-ins, par exemple :

  • @azure/identity-cache-persistence: fournit une mise en cache de jetons persistante
  • @azure/identity-vscode: fournit les dépendances de VisualStudioCodeCredential et l’active

Exemple :

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

Informations relatives à la fonction

deserializeAuthenticationRecord(string)

Désérialise un enregistrement d’authentification sérialisé d’une chaîne dans un objet.

La chaîne d’entrée doit contenir les propriétés suivantes :

  • « autorité »
  • « homeAccountId »
  • « clientId »
  • « tenantId »
  • « nom d’utilisateur »
  • « version »

Si la version que nous recevons n’est pas prise en charge, une erreur est générée.

Pour le moment, la seule version disponible est : « 1.0 », qui est toujours définie lorsque l’enregistrement d’authentification est sérialisé.

function deserializeAuthenticationRecord(serializedRecord: string): AuthenticationRecord

Paramètres

serializedRecord

string

Enregistrement d’authentification précédemment sérialisé en chaîne.

Retours

AuthenticationRecord

AuthenticationRecord.

getDefaultAzureCredential()

Retourne une nouvelle instance de DefaultAzureCredential.

function getDefaultAzureCredential(): TokenCredential

Retours

TokenCredential

serializeAuthenticationRecord(AuthenticationRecord)

Sérialise un AuthenticationRecord dans une chaîne.

La sortie d’un enregistrement d’authentification sérialisé contient les propriétés suivantes :

  • « autorité »
  • « homeAccountId »
  • « clientId »
  • « tenantId »
  • « nom d’utilisateur »
  • « version »

Pour convertir ultérieurement cette chaîne en une chaîne sérialisée AuthenticationRecord, utilisez la fonction deserializeAuthenticationRecord()exportée .

function serializeAuthenticationRecord(record: AuthenticationRecord): string

Paramètres

record
AuthenticationRecord

Retours

string

useIdentityPlugin(IdentityPlugin)

Étendez Azure Identity avec des fonctionnalités supplémentaires. Passez un plug-in à partir d’un package de plug-ins, par exemple :

  • @azure/identity-cache-persistence: fournit une mise en cache de jetons persistante
  • @azure/identity-vscode: fournit les dépendances de VisualStudioCodeCredential et l’active

Exemple :

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
useIdentityPlugin(cachePersistencePlugin);

// The plugin has the capability to extend `DefaultAzureCredential` and to
// add middleware to the underlying credentials, such as persistence.
const credential = new DefaultAzureCredential({
  tokenCachePersistenceOptions: {
    enabled: true
  }
});

function useIdentityPlugin(plugin: IdentityPlugin)

Paramètres

plugin
IdentityPlugin

plug-in à inscrire