ChainedTokenCredential class

Umożliwia wypróbowanie wielu TokenCredential implementacji do momentu, gdy jedna z metod getToken zwróci token dostępu.

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 implementacji łańcuchowych TokenCredential . Zgłasza błąd AggregateAuthenticationError , gdy co najmniej jedno poświadczenie zgłasza błąd 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 należy próbować w określonej kolejności.

Przykład użycia:

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 implementacji łańcuchowych TokenCredential . Zgłasza błąd AggregateAuthenticationError , gdy co najmniej jedno poświadczenie zgłasza błąd 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ę TokenCredential implementację.

Zwraca

Promise<AccessToken>