DefaultAzureCredential class
Tillhandahåller en standardkonfiguration ChainedTokenCredential som fungerar för de flesta program som använder Azure SDK-klientbibliotek. Mer information finns i Översikt över StandardAzureCredential.
Följande typer av autentiseringsuppgifter kommer att provas i ordning:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- BrokerCredential (en asynkron aktiverad autentiseringsuppgift som kräver @azure/identity-broker att den installeras)
Mer information om hur de försöker autentisering finns i dokumentationen för dessa typer av autentiseringsuppgifter.
I följande exempel visas hur du requiredEnvVars använder alternativet för att se till att vissa miljövariabler anges innan instansieras DefaultAzureCredential .
Om någon av de angivna miljövariablerna saknas eller är tom genereras ett fel, vilket förhindrar att programmet fortsätter körningen utan den nödvändiga konfigurationen.
Den visar också hur du ställer in miljövariabeln AZURE_TOKEN_CREDENTIALS för att styra vilka autentiseringsuppgifter som ingår i kedjan.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Extends
Konstruktorer
| Default |
Skapar en instans av klassen DefaultAzureCredential med DefaultAzureCredentialClientIdOptions. |
| Default |
Skapar en instans av klassen DefaultAzureCredential med DefaultAzureCredentialOptions. |
| Default |
Skapar en instans av klassen DefaultAzureCredential med DefaultAzureCredentialResourceIdOptions. |
Ärvda metoder
| get |
Returnerar den första åtkomsttoken som returneras av en av de länkade Den här metoden anropas automatiskt av Azure SDK-klientbibliotek. Du kan anropa den här metoden direkt, men du måste också hantera cachelagring av token och tokenuppdatering. |
Konstruktorinformation
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Skapar en instans av klassen DefaultAzureCredential med DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)
Parametrar
Valfria parametrar. Se DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Skapar en instans av klassen DefaultAzureCredential med DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)
Parametrar
- options
- DefaultAzureCredentialOptions
Valfria parametrar. Se StandardAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Skapar en instans av klassen DefaultAzureCredential med DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)
Parametrar
Valfria parametrar. Se DefaultAzureCredentialResourceIdOptions.
Ärvd metodinformation
getToken(string | string[], GetTokenOptions)
Returnerar den första åtkomsttoken som returneras av en av de länkade TokenCredential-implementeringarna. Genererar en AggregateAuthenticationError- när en eller flera autentiseringsuppgifter genererar en AuthenticationError- och inga autentiseringsuppgifter har returnerat en åtkomsttoken.
Den här metoden anropas automatiskt av Azure SDK-klientbibliotek. Du kan anropa den här metoden direkt, men du måste också hantera cachelagring av token och tokenuppdatering.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Parametrar
- scopes
-
string | string[]
Listan över omfång som token ska ha åtkomst till.
- options
- GetTokenOptions
De alternativ som används för att konfigurera alla begäranden som den här TokenCredential implementeringen kan göra.
Returer
Promise<AccessToken>
ärvd frånChainedTokenCredential.getToken