Udostępnij za pośrednictwem

ChainedTokenCredential class

  • Odwołanie
Pakiet:
@azure/identity

Umożliwia wypróbowanie wielu implementacji TokenCredential, dopóki jedna z metod getToken nie zwróci tokenu dostępu. Aby uzyskać więcej informacji, zobacz ChainedTokenCredential overview.

Konstruktory

ChainedTokenCredential(TokenCredential[])

Tworzy wystąpienie obiektu ChainedTokenCredential przy użyciu podanych poświadczeń.

Metody

getToken(string | string[], GetTokenOptions)

Zwraca pierwszy token dostępu zwrócony przez jedną z wdrożeń TokenCredential łańcuchowych. Zgłasza błąd AggregateAuthenticationError, gdy co najmniej jedno poświadczenie zgłasza AuthenticationError i żadne poświadczenia nie zwróciły tokenu dostępu.

Ta metoda jest wywoływana automatycznie przez biblioteki klienta zestawu Azure SDK. Tę metodę można wywołać bezpośrednio, ale należy również obsługiwać buforowanie tokenów i odświeżanie tokenów.

Szczegóły konstruktora

ChainedTokenCredential(TokenCredential[])

Tworzy wystąpienie obiektu ChainedTokenCredential przy użyciu podanych poświadczeń.

new ChainedTokenCredential(sources: TokenCredential[])

Parametry

sources

TokenCredential[]

TokenCredential implementacje, które mają być wypróbowane w kolejności.

Przykładowe użycie:

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);

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Zwraca pierwszy token dostępu zwrócony przez jedną z wdrożeń TokenCredential łańcuchowych. Zgłasza błąd AggregateAuthenticationError, gdy co najmniej jedno poświadczenie zgłasza AuthenticationError i żadne poświadczenia nie zwróciły tokenu dostępu.

Ta metoda jest wywoływana automatycznie przez biblioteki klienta zestawu Azure SDK. Tę metodę można wywołać bezpośrednio, ale należy również obsługiwać buforowanie tokenów i odświeżanie tokenów.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być wysyłane przez tę implementację TokenCredential.

Zwraca

Promise<AccessToken>