DefaultAzureCredential class

Paket:

@azure/identity

Stellt eine Standardkonfiguration ChainedTokenCredential bereit, die für die meisten Anwendungen funktioniert, die Azure SDK-Clientbibliotheken verwenden. Weitere Informationen finden Sie unter DefaultAzureCredential -Übersicht.

Die folgenden Anmeldeinformationstypen werden in der folgenden Reihenfolge ausprobiert:

• EnvironmentCredential-
• WorkloadIdentityCredential-
• ManagedIdentityCredential-
• VisualStudioCodeCredential
• AzureCliCredential-
• AzurePowerShellCredential-
• AzureDeveloperCliCredential-
• BrokerCredential (eine für den Broker aktivierte Anmeldeinformation, die installiert ist @azure/identity-broker )

Weitere Informationen dazu, wie sie die Authentifizierung versuchen, finden Sie in der Dokumentation dieser Anmeldeinformationstypen.

Im folgenden Beispiel wird veranschaulicht, wie die requiredEnvVars Option verwendet wird, um sicherzustellen, dass bestimmte Umgebungsvariablen festgelegt werden, bevor sie DefaultAzureCredential instanziiert werden. Wenn eine der angegebenen Umgebungsvariablen fehlt oder leer ist, wird ein Fehler ausgelöst, der verhindert, dass die Anwendung ohne die erforderliche Konfiguration ausgeführt wird. Außerdem wird veranschaulicht, wie die AZURE_TOKEN_CREDENTIALS Umgebungsvariable festgelegt wird, um zu steuern, welche Anmeldeinformationen in der Kette enthalten sind.

import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential({
  requiredEnvVars: [
    "AZURE_CLIENT_ID",
    "AZURE_TENANT_ID",
    "AZURE_CLIENT_SECRET",
    "AZURE_TOKEN_CREDENTIALS",
  ],
});

Extends

ChainedTokenCredential

Konstruktoren

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)	Erstellt eine Instanz der DefaultAzureCredential-Klasse mit DefaultAzureCredentialClientIdOptions.
DefaultAzureCredential(DefaultAzureCredentialOptions)	Erstellt eine Instanz der DefaultAzureCredential-Klasse mit DefaultAzureCredentialOptions.
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)	Erstellt eine Instanz der DefaultAzureCredential-Klasse mit DefaultAzureCredentialResourceIdOptions.

Geerbte Methoden

getToken(string | string[], GetTokenOptions)

Gibt das erste Zugriffstoken zurück, das von einer der verketteten TokenCredential Implementierungen zurückgegeben wird. Löst ein AggregateAuthenticationError- aus, wenn mindestens eine Anmeldeinformationen ein AuthenticationError- auslöst und keine Anmeldeinformationen ein Zugriffstoken zurückgegeben haben. Diese Methode wird automatisch von Azure SDK-Clientbibliotheken aufgerufen. Sie können diese Methode direkt aufrufen, aber Sie müssen auch die Tokenzwischenspeicherung und die Token-Aktualisierung behandeln.

Details zum Konstruktor

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

Erstellt eine Instanz der DefaultAzureCredential-Klasse mit DefaultAzureCredentialClientIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

Parameter

options

DefaultAzureCredentialClientIdOptions

Optionale Parameter. Siehe DefaultAzureCredentialClientIdOptions.

DefaultAzureCredential(DefaultAzureCredentialOptions)

Erstellt eine Instanz der DefaultAzureCredential-Klasse mit DefaultAzureCredentialOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

Parameter

options

DefaultAzureCredentialOptions

Optionale Parameter. Siehe DefaultAzureCredentialOptions.

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

Erstellt eine Instanz der DefaultAzureCredential-Klasse mit DefaultAzureCredentialResourceIdOptions.

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

Parameter

options

DefaultAzureCredentialResourceIdOptions

Optionale Parameter. Siehe DefaultAzureCredentialResourceIdOptions.

Details zur geerbten Methode

getToken(string | string[], GetTokenOptions)

Gibt das erste Zugriffstoken zurück, das von einer der verketteten TokenCredential Implementierungen zurückgegeben wird. Löst ein AggregateAuthenticationError- aus, wenn mindestens eine Anmeldeinformationen ein AuthenticationError- auslöst und keine Anmeldeinformationen ein Zugriffstoken zurückgegeben haben.

Diese Methode wird automatisch von Azure SDK-Clientbibliotheken aufgerufen. Sie können diese Methode direkt aufrufen, aber Sie müssen auch die Tokenzwischenspeicherung und die Token-Aktualisierung behandeln.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parameter

scopes

string | string[]

Die Liste der Bereiche, für die das Token Zugriff hat.

options

GetTokenOptions

Die Optionen zum Konfigurieren von Anforderungen, die diese TokenCredential Implementierung vornehmen können.

Gibt zurück

Promise<AccessToken>

vonChainedTokenCredential.getToken