DefaultAzureCredential class
Udostępnia domyślną konfigurację ChainedTokenCredential, która działa w przypadku większości aplikacji korzystających z bibliotek klienckich zestawu Azure SDK. Aby uzyskać więcej informacji, zobacz DefaultAzureCredential overview.
Następujące typy poświadczeń zostaną wypróbowane w następującej kolejności:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- azureDeveloperCliCredential
- BrokerCredential (poświadczenie z obsługą brokera, które wymaga @azure/identity-broker zainstalowania)
Zapoznaj się z dokumentacją tych typów poświadczeń, aby uzyskać więcej informacji na temat sposobu próby uwierzytelnienia.
W poniższym przykładzie pokazano, jak używać tej requiredEnvVars opcji, aby upewnić się, że pewne zmienne środowiskowe są ustawiane przed utworzeniem wystąpienia DefaultAzureCredential .
Jeśli brakuje którejkolwiek z określonych zmiennych środowiskowych lub jest ona pusta, zostanie zgłoszony błąd, który uniemożliwi aplikacji kontynuowanie wykonywania bez niezbędnej konfiguracji.
Pokazano również, jak ustawić zmienną środowiskową AZURE_TOKEN_CREDENTIALS w celu kontrolowania, które poświadczenia są uwzględniane w łańcuchu.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Rozszerzenie
Konstruktory
| Default |
Tworzy wystąpienie klasy DefaultAzureCredential z DefaultAzureCredentialClientIdOptions. |
| Default |
Tworzy wystąpienie klasy DefaultAzureCredential z DefaultAzureCredentialOptions. |
| Default |
Tworzy wystąpienie klasy DefaultAzureCredential z DefaultAzureCredentialResourceIdOptions. |
Metody dziedziczone
| get |
Zwraca pierwszy token dostępu zwrócony przez jedną z wdrożeń 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
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Tworzy wystąpienie klasy DefaultAzureCredential z DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)Parametry
Parametry opcjonalne. Zobacz DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Tworzy wystąpienie klasy DefaultAzureCredential z DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Parametry
- options
- DefaultAzureCredentialOptions
Parametry opcjonalne. Zobacz DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Tworzy wystąpienie klasy DefaultAzureCredential z DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Parametry
Parametry opcjonalne. Zobacz DefaultAzureCredentialResourceIdOptions.
Szczegóły metody dziedziczonej
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>
dziedziczone zChainedTokenCredential.getToken