DefaultAzureCredential class
Alapértelmezett ChainedTokenCredential konfigurációt biztosít, amely az Azure SDK-ügyfélkódtárakat használó legtöbb alkalmazáshoz használható. További információ: DefaultAzureCredential áttekintés.
A rendszer a következő hitelesítőadat-típusokat próbálja meg a következő sorrendben:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- BrokerCredential (egy bróker által engedélyezett hitelesítő adat, amely telepítve @azure/identity-broker van)
A hitelesítő adatok típusainak dokumentációjában további információt talál a hitelesítés megkísérlésének módjáról.
Az alábbi példa bemutatja, hogyan használható a requiredEnvVars beállítás annak biztosítására, hogy bizonyos környezeti változók be legyenek állítva a DefaultAzureCredential példányosítás előtt.
Ha a megadott környezeti változók bármelyike hiányzik vagy üres, a rendszer hibát jelez, amely megakadályozza, hogy az alkalmazás a szükséges konfiguráció nélkül folytassa a végrehajtást.
Azt is bemutatja, hogyan állíthatja be a környezeti változót AZURE_TOKEN_CREDENTIALS a láncban szereplő hitelesítő adatok szabályozására.
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential({
requiredEnvVars: [
"AZURE_CLIENT_ID",
"AZURE_TENANT_ID",
"AZURE_CLIENT_SECRET",
"AZURE_TOKEN_CREDENTIALS",
],
});
- Extends
Konstruktorok
| Default |
Létrehozza a DefaultAzureCredential osztály egy példányát DefaultAzureCredentialClientIdOptions. |
| Default |
Létrehozza a DefaultAzureCredential osztály egy példányát DefaultAzureCredentialOptions. |
| Default |
Létrehozza a DefaultAzureCredential osztály egy példányát DefaultAzureCredentialResourceIdOptions. |
Örökölt metódusok
| get |
Az egyik láncolt Ezt a metódust az Azure SDK-ügyfélkódtárak automatikusan meghívják. Ezt a metódust közvetlenül is meghívhatja, de a jogkivonatok gyorsítótárazását és a jogkivonatok frissítését is kezelnie kell. |
Konstruktor adatai
DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)
Létrehozza a DefaultAzureCredential osztály egy példányát DefaultAzureCredentialClientIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)Paraméterek
Nem kötelező paraméterek. Lásd: DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)
Létrehozza a DefaultAzureCredential osztály egy példányát DefaultAzureCredentialOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)Paraméterek
- options
- DefaultAzureCredentialOptions
Nem kötelező paraméterek. Lásd: DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)
Létrehozza a DefaultAzureCredential osztály egy példányát DefaultAzureCredentialResourceIdOptions.
new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)Paraméterek
Nem kötelező paraméterek. Lásd: DefaultAzureCredentialResourceIdOptions.
Örökölt metódus részletei
getToken(string | string[], GetTokenOptions)
Az egyik láncolt TokenCredential implementáció által visszaadott első hozzáférési jogkivonatot adja vissza.
AggregateAuthenticationError, ha egy vagy több hitelesítő adat AuthenticationError küld, és a hitelesítő adatok nem adnak vissza hozzáférési jogkivonatot.
Ezt a metódust az Azure SDK-ügyfélkódtárak automatikusan meghívják. Ezt a metódust közvetlenül is meghívhatja, de a jogkivonatok gyorsítótárazását és a jogkivonatok frissítését is kezelnie kell.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Paraméterek
- scopes
-
string | string[]
Azon hatókörök listája, amelyekhez a jogkivonatnak hozzáférése lesz.
- options
- GetTokenOptions
A TokenCredential implementáció által küldött kérések konfigurálásához használt beállítások.
Válaszok
Promise<AccessToken>