@azure/identity package

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

Fournit des détails concernant un échec d’authentification avec Azure Active Directory. Le champ errorResponse contient plus d’informations sur l’échec spécifique.

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

Permet l’authentification de 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

Cette certification utilisera les informations de connexion utilisateur actuellement connectées via l'outil de ligne de commande Azure CLI ('az'). Pour ce faire, il lira le token d’accès utilisateur et expirera avec la commande Azure CLI « az account get-access-token ».

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 est construit sur la interface Azure CLI et offre 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 contre Microsoft Entra ID. Le AzureDeveloperClidential authentifie dans un environnement de développement et acquiert un jeton au nom de l’utilisateur ou du principal de service connecté dans la CLI Azure Developer. Il agit comme l’utilisateur ou le principal de service connecté pour la CLI Azure Developer et exécute une commande Azure CLI en dessous pour authentifier l’application avec Microsoft Entra ID.

Configurer AzureDeveloperCliCredential

Pour utiliser cette accréditation, 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 s’authentifier en tant que principal de service.

Vous devrez peut-être répéter ce processus après une certaine période, 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.

Cette certification est conçue pour être utilisée dans Azure Pipelines avec des connexions de service comme configuration pour la fédération d’identité de charge de travail.

Cette certification utilisera les informations utilisateur actuellement connectées du module Azure PowerShell. Pour ce faire, il lira le jeton d’accès utilisateur et l’expiration avec Azure PowerShell commande Get-AzAccessToken -ResourceUrl {ResourceScope}

Permet à plusieurs implémentations de TokenCredential d’être essayées dans l’ordre jusqu’à ce que l’une des méthodes getToken retourne un jeton d’accès. Pour plus d’informations, consultez vue d’ensemble de ChainedTokenCredential.

Authentifie un principal de service avec une assertion JWT.

Permet l’authentification de Microsoft Entra ID à l’aide d’un certificat encodé en PEM attribué à une inscription d’application. Vous trouverez plus d’informations sur la configuration de l’authentification par certificat ici :

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

Permet l’authentification de Microsoft Entra ID à l’aide d’un secret client généré 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

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

Fournit une configuration par défaut ChainedTokenCredential qui fonctionne pour la plupart des applications utilisant Kit de développement logiciel (SDK) Azure bibliothèques clients. Pour plus d’informations, consultez la vue d’ensemble de DefaultAzureCredential.

Les types d’informations d’identification suivants seront essayés, dans l’ordre :

• EnvironnementRéférence
• WorkloadIdentityCredential
• ManagedIdentityCredential
• VisualStudioCodeCredential
• AzureCliCredential
• AzurePowerShellCredential
• AzureDeveloperCliCredential
• BrokerCredential (informations d’identification activées par le broker qui nécessitent l’installation @azure/identity-broker de est installé)

Pour plus d’informations sur la façon dont ils tentent l’authentification, consultez la documentation de ces types d’informations d’identification.

L’exemple suivant montre comment utiliser l’option pour s’assurer requiredEnvVars que certaines variables d’environnement sont définies avant que l’instanciation ne DefaultAzureCredential soit instanciée. Si l’une des variables d’environnement spécifiées est manquante ou vide, une erreur est générée, empêchant l’application de poursuivre son exécution sans la configuration nécessaire. Il montre également comment définir la variable d’environnement AZURE_TOKEN_CREDENTIALS pour contrôler les informations d’identification incluses dans la chaîne.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});

Permet l’authentification de Microsoft Entra ID à l’aide d’un code de périphérique que l’utilisateur peut saisir dans https://microsoft.com/devicelogin.

Permet l’authentification sur Microsoft Entra ID à l’aide d’un secret client ou d’un certificat.

Permet l’authentification de Microsoft Entra ID dans le navigateur web via le flux de connexion interactif.

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

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

Permet l’authentification de Microsoft Entra ID en utilisant le Au nom de flow.

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

Se connecte à Azure en utilisant le compte utilisateur connecté via l’extension Azure Resources dans Visual Studio Code. Une fois que l’utilisateur s’est connecté via l’extension, ces informations d’identification peuvent partager le même jeton d’actualisation que celui mis en cache par l’extension.

L’authentification par identité de charge de travail est une fonctionnalité d’Azure qui permet aux applications fonctionnant sur des machines virtuelles (VM) d’accéder à d’autres ressources Azure sans avoir besoin d’un principal de service ou d’une identité géré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. En base, l’authentification par identité de charge de travail utilise le concept de crédents de compte de service (SAC), qui sont automatiquement créés par Azure et stockés de manière sécurisée dans la VM. En utilisant l’authentification d’identité de charge de travail, vous pouvez éviter d’avoir à gérer et à faire pivoter les principaux de service ou les identités managées pour chaque application sur chaque machine virtuelle. De plus, comme les SAC sont créés automatiquement et gérés par Azure, vous n'avez pas à vous soucier de stocker et sécuriser eux-mêmes les identifiants sensibles. WorkloadIdentityCredential prend en charge l’authentification ID de charge de travail Microsoft Entra sur Azure Kubernetes et acquiert un jeton en utilisant les SAC disponibles dans l’environnement Azure Kubernetes. Consultez ID de charge de travail Microsoft Entra pour plus d’informations.

Représente un jeton d’accès avec un délai d’expiration.

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

Paramètres facultatifs pour l' AuthenticationRequiredError

Fournit des options pour configurer la validation de l’autorité par la bibliothèque Identity lors des demandes d’authentification vers Microsoft Entra ID.

Options du AuthorizationCodeCredential

Options du AzureCliCredential

Options pour l' AzureDeveloperCliCredential

Paramètres facultatifs pour la classe AzurePipelinesCredential.

Options de l'azurePowerShellCredential

Options de configuration pour InteractiveBrowserCredential pour prendre en charge l’authentification du répartiteur WAM.

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

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

Options de configuration partagée pour la personnalisation du navigateur

Options du clientAssertionCredential

Paramètres facultatifs pour la classe clientCertificateCredential .

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

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

Paramètres facultatifs pour la classe clientSecretCredential .

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

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.

Fournit des options pour configurer la classe DefaultAzureCredential.

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.

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

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.

Permet l’authentification de Microsoft Entra ID selon les variables d’environnement disponibles. Définit les options de la classe EnvironmentCredential.

Pour plus d’informations, consultez la documentation officielle :

https://learn.microsoft.com/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.

Options de configuration du fournisseur de jetons.

Définit les options de TokenCredential.getToken.

Définit les options courantes pour la classe InteractiveBrowserCredential.

Définit les options courantes pour la classe InteractiveBrowserCredential.

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

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

Options à envoyer sur le constructeur ManagedIdentityCredential. Cette variante prend en charge objectId en tant qu’argument de constructeur.

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

Options pour les applications multilocataires qui autorisent les locataires autorisés.

Définit les paramètres pour authentifier le OnBehalfOfCredential avec une assertion.

Définit les paramètres pour authentifier le OnBehalfOfCredential avec un certificat.

Définit les paramètres pour authentifier le OnBehalfOfCredential avec un secret.

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

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

Offre des options pour configurer la manière dont la bibliothèque Identity effectue les requêtes d’authentification vers Microsoft Entra ID.

Définit les options de la classe UsernamePasswordCredential.

Offre des options pour configurer l’identifiant Visual Studio Code.

Options de WorkloadIdentityCredential

Paramètres qui activent l’authentification du répartiteur WAM dans InteractiveBrowserCredential.

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

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

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

Variables d’environnement couramment prises en charge pour la classe DefaultAzureCredential .

Définit la signature d’un rappel qui sera transmis à DeviceCodeCredential pour afficher les détails de l’authentification à l’utilisateur.

Le type d’un plugin Azure Identity, une fonction acceptant un contexte de plugin.

Paramètres facultatifs pour la classe OnBehalfOfCredential.

Une liste des hôtes d’autorité Azure connus

Désérialise un enregistrement d’authentification sérialisé précédemment à partir 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 levée.

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

Retourne un rappel qui fournit un jeton du porteur. Par exemple, le jeton du porteur peut être utilisé pour authentifier une demande comme suit :

import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
import { createPipelineRequest } from "@azure/core-rest-pipeline";

const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const getAccessToken = getBearerTokenProvider(credential, scope);
const token = await getAccessToken();

// usage
const request = createPipelineRequest({ url: "https://example.com" });
request.headers.set("Authorization", `Bearer ${token}`);

Retourne une nouvelle instance duDefaultAzureCredential .

Sérialise une 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 AuthenticationRecordsérialisée, utilisez la fonction exportée deserializeAuthenticationRecord().

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

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

Exemple:

import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

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

La valeur Error.name d’une ErrorAgrégateAuthenticationError

La valeur Error.name d’une erreur d’authentification

La valeur Error.name d’un DiplômeIndisponible

L’AzureLogger utilisé pour tous les clients du package d’identité