DefaultAzureCredential class

Paquet:

@azure/identity

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

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

• EnvironmentCredential
• 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",
  ],
});

Extends

ChainedTokenCredential

Constructeurs

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)	Crée une instance de la classe DefaultAzureCredential avec DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)	Crée une instance de la classe DefaultAzureCredential avec DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)	Crée une instance de la classe DefaultAzureCredential avec DefaultAzureCredentialResourceIdOptions.

Méthodes héritées

getToken(string | string[], GetTokenOptions)

Retourne le premier jeton d’accès retourné par l’une des implémentations de TokenCredential chaînées. Lève une AggregateAuthenticationError lorsqu’une ou plusieurs informations d’identification lèvent un AuthenticationError et qu’aucune information d’identification n’a retourné un jeton d’accès. Cette méthode est appelée automatiquement par les bibliothèques clientes du Kit de développement logiciel (SDK) Azure. Vous pouvez appeler cette méthode directement, mais vous devez également gérer la mise en cache des jetons et l’actualisation des jetons.

Détails du constructeur

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Crée une instance de la classe DefaultAzureCredential avec DefaultAzureCredentialClientIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Paramètres

options

DefaultAzureCredentialClientIdOptions

Paramètres facultatifs. Consultez DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Crée une instance de la classe DefaultAzureCredential avec DefaultAzureCredentialOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Paramètres

options

DefaultAzureCredentialOptions

Paramètres facultatifs. Consultez DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Crée une instance de la classe DefaultAzureCredential avec DefaultAzureCredentialResourceIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Paramètres

options

DefaultAzureCredentialResourceIdOptions

Paramètres facultatifs. Consultez DefaultAzureCredentialResourceIdOptions.

Détails de la méthode héritée

getToken(string | string[], GetTokenOptions)

Retourne le premier jeton d’accès retourné par l’une des implémentations de TokenCredential chaînées. Lève une AggregateAuthenticationError lorsqu’une ou plusieurs informations d’identification lèvent un AuthenticationError et qu’aucune information d’identification n’a retourné un jeton d’accès.

Cette méthode est appelée automatiquement par les bibliothèques clientes du Kit de développement logiciel (SDK) Azure. Vous pouvez appeler cette méthode directement, mais vous devez également gérer la mise en cache des jetons et l’actualisation des jetons.

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

Les options utilisées pour configurer toutes les demandes que cette implémentation TokenCredential peut effectuer.

Retours

Promise<AccessToken>

héritée deChainedTokenCredential.getToken