UsernamePasswordCredential class

Warnung

Diese API ist nun veraltet.

UsernamePasswordCredential is deprecated. Use a more secure credential. See https://aka.ms/azsdk/identity/mfa for details.

Ermöglicht die Authentifizierung der Microsoft Entra ID mit Benutzername und Passwort eines Benutzers. Für diese Anmeldeinformationen ist eine hohe Vertrauenswürdigkeit erforderlich, sodass Sie sie nur verwenden sollten, wenn andere, sicherere Anmeldeinformationstypen nicht verwendet werden können.

Konstruktoren

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

Erstellt eine Instanz des BenutzernamenPasswordCredential mit den Details, die zur Authentifizierung gegen die Microsoft Entra ID mit Benutzernamen und Passwort erforderlich sind.

Methoden

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra ID und gibt bei Erfolg ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Wenn der Benutzer die Option disableAutomaticAuthenticationbereitgestellt hat, wird diese Methode nicht versucht, die Benutzerinteraktion zum Abrufen des Tokens anzufordern, sobald das Token nicht im Hintergrund abgerufen werden kann.

Details zum Konstruktor

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

Erstellt eine Instanz des BenutzernamenPasswordCredential mit den Details, die zur Authentifizierung gegen die Microsoft Entra ID mit Benutzernamen und Passwort erforderlich sind.

new UsernamePasswordCredential(tenantId: string, clientId: string, username: string, password: string, options?: UsernamePasswordCredentialOptions)

Parameter

tenantId

string

Der Microsoft Entra-Tenant (Verzeichnis).

clientId

string

Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.

username

string

Die E-Mail-Adresse des Benutzerkontos (Benutzername).

password

string

Kontokennwort des Benutzerkontos

options
UsernamePasswordCredentialOptions

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 Erfolg ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Wenn der Benutzer die Option disableAutomaticAuthenticationbereitgestellt hat, wird diese Methode nicht versucht, die Benutzerinteraktion zum Abrufen des Tokens anzufordern, sobald das Token nicht im Hintergrund abgerufen werden kann.

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 möglicherweise vorgibt.

Gibt zurück

Promise<AccessToken>