Udostępnij za pośrednictwem

DefaultAzureCredential class

  • Odwołanie
Pakiet:
@azure/identity

Udostępnia domyślną konfigurację ChainedTokenCredential , która powinna działać dla większości aplikacji korzystających z zestawu Azure SDK.

Extends
ChainedTokenCredential

Konstruktory

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Tworzy wystąpienie klasy DefaultAzureCredential z wartością DefaultAzureCredentialClientIdOptions

To poświadczenie zapewnia domyślną konfigurację ChainedTokenCredential , która powinna działać w przypadku większości aplikacji korzystających z zestawu Azure SDK.

Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:

Zapoznaj się z dokumentacją tych typów poświadczeń, aby uzyskać więcej informacji na temat sposobu próby uwierzytelnienia.
DefaultAzureCredential(DefaultAzureCredentialOptions)

Tworzy wystąpienie klasy DefaultAzureCredential z wartością DefaultAzureCredentialOptions

To poświadczenie zapewnia domyślną konfigurację ChainedTokenCredential , która powinna działać w przypadku większości aplikacji korzystających z zestawu Azure SDK.

Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:

Zapoznaj się z dokumentacją tych typów poświadczeń, aby uzyskać więcej informacji na temat sposobu próby uwierzytelnienia.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Tworzy wystąpienie klasy DefaultAzureCredential z wartością DefaultAzureCredentialResourceIdOptions

To poświadczenie zapewnia domyślną konfigurację ChainedTokenCredential , która powinna działać w przypadku większości aplikacji korzystających z zestawu Azure SDK.

Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:

Aby uzyskać więcej informacji na temat próby uwierzytelnienia, zapoznaj się z dokumentacją tych typów poświadczeń.

Metody dziedziczone

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. Możesz wywołać tę metodę bezpośrednio, ale musisz również obsługiwać buforowanie tokenów i odświeżanie tokenów.

Szczegóły konstruktora

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Tworzy wystąpienie klasy DefaultAzureCredential z wartością DefaultAzureCredentialClientIdOptions

To poświadczenie zapewnia domyślną konfigurację ChainedTokenCredential , która powinna działać w przypadku większości aplikacji korzystających z zestawu Azure SDK.

Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:

Zapoznaj się z dokumentacją tych typów poświadczeń, aby uzyskać więcej informacji na temat sposobu próby uwierzytelnienia.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Parametry

options
DefaultAzureCredentialClientIdOptions

Parametry opcjonalne. Zobacz DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Tworzy wystąpienie klasy DefaultAzureCredential z wartością DefaultAzureCredentialOptions

To poświadczenie zapewnia domyślną konfigurację ChainedTokenCredential , która powinna działać w przypadku większości aplikacji korzystających z zestawu Azure SDK.

Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:

Zapoznaj się z dokumentacją tych typów poświadczeń, aby uzyskać więcej informacji na temat sposobu próby uwierzytelnienia.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Parametry

options
DefaultAzureCredentialOptions

Parametry opcjonalne. Zobacz DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Tworzy wystąpienie klasy DefaultAzureCredential z wartością DefaultAzureCredentialResourceIdOptions

To poświadczenie zapewnia domyślną konfigurację ChainedTokenCredential , która powinna działać w przypadku większości aplikacji korzystających z zestawu Azure SDK.

Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:

Aby uzyskać więcej informacji na temat próby uwierzytelnienia, zapoznaj się z dokumentacją tych typów poświadczeń.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Parametry

options
DefaultAzureCredentialResourceIdOptions

Parametry opcjonalne. Zobacz DefaultAzureCredentialResourceIdOptions.

Szczegóły metody dziedziczonej

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. Możesz wywołać tę metodę bezpośrednio, ale musisz 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 wszelkich żądań, które może wykonać ta TokenCredential implementacja.

Zwraca

Promise<AccessToken>

Dziedziczone zchainedTokenCredential.getToken