Freigeben über

EnvironmentCredential class

  • Referenz
Paket:
@azure/identity

Ermöglicht die Authentifizierung von Microsoft Entra-ID mithilfe eines geheimen Clientschlüssels oder Zertifikats oder als Benutzer mit einem Benutzernamen und Kennwort.

Konstruktoren

EnvironmentCredential(EnvironmentCredentialOptions)

Erstellt eine Instanz der EnvironmentCredential-Klasse und entscheidet, welche Anmeldeinformationen abhängig von den verfügbaren Umgebungsvariablen verwendet werden sollen.

Erforderliche Umgebungsvariablen:

  • AZURE_TENANT_ID: Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).
  • AZURE_CLIENT_ID: Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.

Wenn Sie die AZURE_TENANT_ID festlegen, können Sie auch die zusätzlich zulässigen Mandanten festlegen.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Gibt für Mehrinstanzenanwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token mit einer einzelnen durch Semikolons getrennten Zeichenfolge abrufen können. Verwenden Sie *, um alle Mandanten zuzulassen.

Umgebungsvariablen, die für die Clientanmeldeinformationsauthentifizierung verwendet werden:

  • AZURE_CLIENT_SECRET: Ein geheimer Clientschlüssel, der für die App-Registrierung generiert wurde.
  • AZURE_CLIENT_CERTIFICATE_PATH: Der Pfad zu einem PEM-Zertifikat, das während der Authentifizierung verwendet werden soll, anstelle des geheimen Clientschlüssels.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optional) Kennwort für die Zertifikatdatei.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (optional) gibt an, dass die Zertifikatkette im x5c-Header festgelegt werden soll, um die antragstellername/ausstellerbasierte Authentifizierung zu unterstützen.

Alternativ können Benutzer Umgebungsvariablen für die Benutzernamen- und Kennwortauthentifizierung bereitstellen:

  • AZURE_USERNAME: Benutzername für die Authentifizierung.
  • AZURE_PASSWORD: Kennwort für die Authentifizierung.

Wenn die zum Ausführen der Authentifizierung erforderlichen Umgebungsvariablen fehlen, wird ein CredentialUnavailableError ausgelöst. Wenn die Authentifizierung fehlschlägt oder ein unbekannter Fehler auftritt, wird ein AuthenticationError- ausgelöst.

Methoden

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück.

Details zum Konstruktor

EnvironmentCredential(EnvironmentCredentialOptions)

Erstellt eine Instanz der EnvironmentCredential-Klasse und entscheidet, welche Anmeldeinformationen abhängig von den verfügbaren Umgebungsvariablen verwendet werden sollen.

Erforderliche Umgebungsvariablen:

  • AZURE_TENANT_ID: Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).
  • AZURE_CLIENT_ID: Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.

Wenn Sie die AZURE_TENANT_ID festlegen, können Sie auch die zusätzlich zulässigen Mandanten festlegen.

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Gibt für Mehrinstanzenanwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token mit einer einzelnen durch Semikolons getrennten Zeichenfolge abrufen können. Verwenden Sie *, um alle Mandanten zuzulassen.

Umgebungsvariablen, die für die Clientanmeldeinformationsauthentifizierung verwendet werden:

  • AZURE_CLIENT_SECRET: Ein geheimer Clientschlüssel, der für die App-Registrierung generiert wurde.
  • AZURE_CLIENT_CERTIFICATE_PATH: Der Pfad zu einem PEM-Zertifikat, das während der Authentifizierung verwendet werden soll, anstelle des geheimen Clientschlüssels.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optional) Kennwort für die Zertifikatdatei.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (optional) gibt an, dass die Zertifikatkette im x5c-Header festgelegt werden soll, um die antragstellername/ausstellerbasierte Authentifizierung zu unterstützen.

Alternativ können Benutzer Umgebungsvariablen für die Benutzernamen- und Kennwortauthentifizierung bereitstellen:

  • AZURE_USERNAME: Benutzername für die Authentifizierung.
  • AZURE_PASSWORD: Kennwort für die Authentifizierung.

Wenn die zum Ausführen der Authentifizierung erforderlichen Umgebungsvariablen fehlen, wird ein CredentialUnavailableError ausgelöst. Wenn die Authentifizierung fehlschlägt oder ein unbekannter Fehler auftritt, wird ein AuthenticationError- ausgelöst.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parameter

options
EnvironmentCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.

Details zur Methode

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück.

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

Optionale Parameter. Siehe GetTokenOptions-.

Gibt zurück

Promise<AccessToken>