Partager via

ChainedTokenCredential class

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

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.

Constructeurs

ChainedTokenCredential(TokenCredential[])

Crée une instance de ChainedTokenCredential à l’aide des informations d’identification données.

Méthodes

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

ChainedTokenCredential(TokenCredential[])

Crée une instance de ChainedTokenCredential à l’aide des informations d’identification données.

new ChainedTokenCredential(sources: TokenCredential[])

Paramètres

sources

TokenCredential[]

TokenCredential implémentations à essayer dans l’ordre.

Exemple d’utilisation :

import { ClientSecretCredential, ChainedTokenCredential } from "@azure/identity";

const tenantId = "<tenant-id>";
const clientId = "<client-id>";
const clientSecret = "<client-secret>";
const anotherClientId = "<another-client-id>";
const anotherSecret = "<another-client-secret>";

const firstCredential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const secondCredential = new ClientSecretCredential(tenantId, anotherClientId, anotherSecret);

const credentialChain = new ChainedTokenCredential(firstCredential, secondCredential);

Détails de la méthode

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>