EnvironmentCredential class

  • Referenz
Paket:
@azure/identity

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

Konstruktoren

EnvironmentCredential(EnvironmentCredentialOptions)

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

Erforderliche Umgebungsvariablen:

  • AZURE_TENANT_ID: Die Microsoft Entra Mandanten -ID (Verzeichnis).
  • AZURE_CLIENT_ID: Die Client-ID (Anwendung) 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 mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token mit einer einzelnen durch Semikolon getrennten Zeichenfolge abrufen können. Verwenden Sie * , um alle Mandanten zuzulassen.

Für die Authentifizierung von Clientanmeldeinformationen verwendete Umgebungsvariablen:

  • 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 anstelle des geheimen Clientschlüssels verwendet werden soll.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optional) Kennwort für die Zertifikatdatei.

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

  • AZURE_USERNAME: Benutzername, mit dem authentifiziert werden soll.
  • AZURE_PASSWORD: Kennwort für die Authentifizierung.

Wenn die für die Authentifizierung erforderlichen Umgebungsvariablen fehlen, wird ein CredentialUnavailableError ausgelöst. Wenn die Authentifizierung fehlschlägt oder ein unbekannter Fehler vorliegt, wird ein AuthenticationError ausgelöst.

Methoden

getToken(string | string[], GetTokenOptions)

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

Details zum Konstruktor

EnvironmentCredential(EnvironmentCredentialOptions)

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

Erforderliche Umgebungsvariablen:

  • AZURE_TENANT_ID: Die Microsoft Entra Mandanten -ID (Verzeichnis).
  • AZURE_CLIENT_ID: Die Client-ID (Anwendung) 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 mehrinstanzenfähige Anwendungen zusätzliche Mandanten an, für die die Anmeldeinformationen Token mit einer einzelnen durch Semikolon getrennten Zeichenfolge abrufen können. Verwenden Sie * , um alle Mandanten zuzulassen.

Für die Authentifizierung von Clientanmeldeinformationen verwendete Umgebungsvariablen:

  • 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 anstelle des geheimen Clientschlüssels verwendet werden soll.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optional) Kennwort für die Zertifikatdatei.

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

  • AZURE_USERNAME: Benutzername, mit dem authentifiziert werden soll.
  • AZURE_PASSWORD: Kennwort für die Authentifizierung.

Wenn die für die Authentifizierung erforderlichen Umgebungsvariablen fehlen, wird ein CredentialUnavailableError ausgelöst. Wenn die Authentifizierung fehlschlägt oder ein unbekannter Fehler vorliegt, wird ein AuthenticationError ausgelöst.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parameter

options
EnvironmentCredentialOptions

Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung stellt.

Details zur Methode

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit 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, auf die das Token Zugriff hat.

options
GetTokenOptions

Optionale Parameter. Weitere Informationen finden Sie unter GetTokenOptions.

Gibt zurück

Promise<AccessToken>