EnvironmentCredential Klasse

Definition

Namespace:

Azure.Identity

Assembly:

Azure.Identity.dll

Paket:

Azure.Identity v1.12.0

Quelle:

EnvironmentCredential.cs

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

Die Konfiguration wird in dieser Reihenfolge mithilfe der folgenden Umgebungsvariablen versucht:

Dienstprinzipal mit Geheimnis:

Variable	BESCHREIBUNG
AZURE_TENANT_ID	Die Microsoft Entra Mandanten (Verzeichnis)-ID.
AZURE_CLIENT_ID	Die Client- (Anwendungs-)ID einer App-Registrierung im Mandanten.
AZURE_CLIENT_SECRET	Ein geheimer Clientschlüssel, der für die App-Registrierung generiert wurde

Dienstprinzipal mit Zertifikat:

Variable	BESCHREIBUNG
AZURE_TENANT_ID	Die Microsoft Entra Mandanten (Verzeichnis)-ID.
AZURE_CLIENT_ID	Die Client- (Anwendungs-)ID einer App-Registrierung im Mandanten.
AZURE_CLIENT_CERTIFICATE_PATH	Ein Pfad zum Zertifikat und zum privaten Schlüsselpaar im PEM- oder PFX-Format für die Authentifizierung der App-Registrierung
AZURE_CLIENT_CERTIFICATE_PASSWORD	(Optional) Das Kennwort, das die Zertifikatdatei schützt (derzeit nur für PFX-Zertifikate (PKCS12) unterstützt).
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN	(Optional) Gibt an, ob eine Authentifizierungsanforderung einen x5c-Header enthält, um die auf Antragstellernamen/Aussteller basierende Authentifizierung zu unterstützen. Wenn sie auf "true" oder "1" festgelegt sind, enthalten Authentifizierungsanforderungen den x5c-Header.

Benutzername und Kennwort:

Variable	BESCHREIBUNG
AZURE_TENANT_ID	Die Microsoft Entra Mandanten (Verzeichnis)-ID.
AZURE_CLIENT_ID	Die Client- (Anwendungs-)ID einer App-Registrierung im Mandanten.
AZURE_USERNAME	Der Benutzername eines Microsoft Entra Benutzerkontos, auch als upn bezeichnet.
AZURE_PASSWORD	Das Kennwort des Microsoft Entra Benutzerkontos. Beachten Sie, dass Konten mit aktivierter MFA nicht unterstützt werden.

Diese Anmeldeinformationen verwenden letztendlich ein ClientSecretCredential, ClientCertificateCredentialoder UsernamePasswordCredential , um die Authentifizierung mithilfe dieser Details durchzuführen. Weitere Informationen finden Sie in der Dokumentation dieser Klasse.

public class EnvironmentCredential : Azure.Core.TokenCredential

type EnvironmentCredential = class
    inherit TokenCredential

Public Class EnvironmentCredential
Inherits TokenCredential

Vererbung

Object

TokenCredential

EnvironmentCredential

Konstruktoren

EnvironmentCredential()	Erstellt eine instance der EnvironmentCredential-Klasse und liest geheime Clientschlüsseldetails aus Umgebungsvariablen. Wenn die erwarteten Umgebungsvariablen zu diesem Zeitpunkt nicht gefunden werden, gibt die GetToken-Methode beim Aufrufen den Standardwert AccessToken zurück.
EnvironmentCredential(EnvironmentCredentialOptions)	Erstellt eine instance der EnvironmentCredential-Klasse und liest geheime Clientschlüsseldetails aus Umgebungsvariablen. Wenn die erwarteten Umgebungsvariablen zu diesem Zeitpunkt nicht gefunden werden, gibt die GetToken-Methode beim Aufrufen den Standardwert AccessToken zurück.

Methoden

GetToken(TokenRequestContext, CancellationToken)

Ruft ein Token von Microsoft Entra-ID unter Verwendung der angegebenen Clientdetails ab, die in den Umgebungsvariablen AZURE_TENANT_ID, AZURE_CLIENT_ID und AZURE_CLIENT_SECRET oder AZURE_USERNAME und AZURE_PASSWORD angegeben sind. Erworbene Token werden von den Anmeldeinformationen instance zwischengespeichert. Tokenlebensdauer und Aktualisierung werden automatisch verarbeitet. Verwenden Sie nach Möglichkeit Anmeldeinformationsinstanzen wieder, um die Cacheeffektivität zu optimieren.

GetTokenAsync(TokenRequestContext, CancellationToken)

Ruft ein Token von Microsoft Entra-ID unter Verwendung der angegebenen Clientdetails ab, die in den Umgebungsvariablen AZURE_TENANT_ID, AZURE_CLIENT_ID und AZURE_CLIENT_SECRET oder AZURE_USERNAME und AZURE_PASSWORD angegeben sind. Erworbene Token werden von den Anmeldeinformationen instance zwischengespeichert. Tokenlebensdauer und Aktualisierung werden automatisch verarbeitet. Verwenden Sie nach Möglichkeit Anmeldeinformationsinstanzen wieder, um die Cacheeffektivität zu optimieren.