DefaultAzureCredential class
Poskytuje výchozí konfiguraci ChainedTokenCredential, která funguje pro většinu aplikací, které používají klientské knihovny sady Azure SDK. Další informace naleznete v tématu DefaultAzureCredential přehled.
V tomto pořadí se budou zkoušit následující typy přihlašovacích údajů:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- azureCliCredential
- azurePowerShellCredential
- azureDeveloperCliCredential
- BrokerCredential (je nainstalováno přihlašovací údaje s povoleným zprostředkovatelem, které vyžaduje @azure/identity-broker )
Další informace o tom, jak se pokouší o ověření, najdete v dokumentaci těchto typů přihlašovacích údajů.
Následující příklad ukazuje, jak použít tuto requiredEnvVars možnost k zajištění toho, aby určité proměnné prostředí byly nastaveny před vytvořením instance.DefaultAzureCredential
Pokud některá ze zadaných proměnných prostředí chybí nebo je prázdná, bude vyvolána chyba, která zabrání aplikaci pokračovat v provádění bez potřebné konfigurace.
Ukazuje také, jak nastavit proměnnou AZURE_TOKEN_CREDENTIALS prostředí pro řízení, které přihlašovací údaje jsou zahrnuty do řetězce.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Extends
Konstruktory
| Default |
Vytvoří instanci DefaultAzureCredential třídy s DefaultAzureCredentialClientIdOptions. |
| Default |
Vytvoří instanci DefaultAzureCredential třídy s DefaultAzureCredentialOptions. |
| Default |
Vytvoří instanci DefaultAzureCredential třídy s DefaultAzureCredentialResourceIdOptions. |
Zděděné metody
| get |
Vrátí první přístupový token vrácený jednou z zřetězených Tato metoda se volá automaticky klientskými knihovnami sady Azure SDK. Tuto metodu můžete volat přímo, ale musíte také zpracovat ukládání tokenů do mezipaměti a aktualizaci tokenů. |
Podrobnosti konstruktoru
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Vytvoří instanci DefaultAzureCredential třídy s DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)Parametry
Volitelné parametry. Viz DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Vytvoří instanci DefaultAzureCredential třídy s DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Parametry
- options
- DefaultAzureCredentialOptions
Volitelné parametry. Viz DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Vytvoří instanci DefaultAzureCredential třídy s DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Parametry
Volitelné parametry. Viz DefaultAzureCredentialResourceIdOptions.
Podrobnosti zděděných metod
getToken(string | string[], GetTokenOptions)
Vrátí první přístupový token vrácený jednou z zřetězených TokenCredential implementací. Vyvolá AggregateAuthenticationError, když jeden nebo více přihlašovacích údajů vyvolá AuthenticationError a žádné přihlašovací údaje nevrátily přístupový token.
Tato metoda se volá automaticky klientskými knihovnami sady Azure SDK. Tuto metodu můžete volat přímo, ale musíte také zpracovat ukládání tokenů do mezipaměti a aktualizaci tokenů.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Parametry
- scopes
-
string | string[]
Seznam oborů, pro které bude mít token přístup.
- options
- GetTokenOptions
Možnosti použité ke konfiguraci všech požadavků, které tato implementace TokenCredential může provést.
Návraty
Promise<AccessToken>
zděděno zChainedTokenCredential.getToken