UsernamePasswordCredential Klasse

Authentifiziert einen Benutzer mit einem Benutzernamen und einem Kennwort.

Im Allgemeinen empfiehlt Microsoft diese Art der Authentifizierung nicht, da sie weniger sicher ist als andere Authentifizierungsflüsse.

Die Authentifizierung mit diesen Anmeldeinformationen ist nicht interaktiv, sodass sie nicht mit jeder Form der mehrstufigen Authentifizierung oder Zustimmungsaufforderung kompatibel ist. Die Anwendung muss bereits über die Zustimmung des Benutzers oder eines Verzeichnisadministrators verfügen.

Diese Anmeldeinformationen können nur Geschäfts- und Schulkonten authentifizieren. Microsoft-Konten werden nicht unterstützt. Weitere Informationen zu Kontotypen finden Sie in der Dokumentation zu Azure Active Directory .

Vererbung

azure.identity._internal.interactive.InteractiveCredential

UsernamePasswordCredential

Konstruktor

UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)

Parameter

client_id

str

Erforderlich

Die Client-ID der Anwendung

username

str

Erforderlich

Der Benutzername des Benutzers (in der Regel eine E-Mail-Adresse)

password

str

Erforderlich

Das Kennwort des Benutzers

authority

str

Autorität eines Azure Active Directory-Endpunkts, z. B. "login.microsoftonline.com", der Autorität für die öffentliche Azure-Cloud (standard). AzureAuthorityHosts definiert Autoritäten für andere Clouds.

tenant_id

str

Mandanten-ID oder eine Domäne, die einem Mandanten zugeordnet ist. Wenn nicht angegeben, wird standardmäßig der Mandant "organizations" verwendet, der nur Azure Active Directory-Geschäfts- oder Schulkonten unterstützt.

cache_persistence_options

TokenCachePersistenceOptions

Konfiguration für die persistente Tokenzwischenspeicherung. Wenn sie nicht angegeben sind, werden die Anmeldeinformationen Token im Arbeitsspeicher zwischenspeichern.

disable_instance_discovery

bool

Bestimmt, ob instance Ermittlung ausgeführt wird, wenn versucht wird, sich zu authentifizieren. Wenn Sie dies auf true festlegen, werden sowohl instance Ermittlung als auch die Validierung von Autoritäten vollständig deaktiviert. Diese Funktionalität ist für die Verwendung in Szenarien vorgesehen, in denen der Metadatenendpunkt nicht erreicht werden kann, z. B. in privaten Clouds oder Azure Stack. Der Prozess der instance Ermittlung umfasst das Abrufen von Autoritätsmetadaten aus, https://login.microsoft.com/ um die Autorität zu überprüfen. Wenn Sie dies auf True festlegen, wird die Überprüfung der Autorität deaktiviert. Daher ist es wichtig sicherzustellen, dass der konfigurierte Autoritätshost gültig und vertrauenswürdig ist.

additionally_allowed_tenants

List[str]

Gibt Mandanten zusätzlich zum angegebenen "tenant_id" an, für den die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, auf den die Anwendung zugreifen kann.

Beispiele

Erstellen Sie einen BenutzernamenPasswordCredential.

   from azure.identity import UsernamePasswordCredential

   credential = UsernamePasswordCredential(
       client_id="<client_id>",
       username="<username>",
       password="<password>",
   )

Methoden

authenticate	Interaktive authentifizierung eines Benutzers.
close
get_token	Fordern Sie ein Zugriffstoken für Bereiche an. Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

authenticate

Interaktive authentifizierung eines Benutzers.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parameter

scopes

Iterable[str]

Bereiche, die während der Authentifizierung angefordert werden sollen, z. B. die von bereitgestellten scopes. Falls angegeben, speichert die erfolgreiche Authentifizierung ein Zugriffstoken für diese Bereiche zwischen.

claims

str

zusätzliche Ansprüche, die im Token erforderlich sind, z. B. die von claims

Rückgabetyp

AuthenticationRecord

Ausnahmen

ClientAuthenticationError

Fehler bei der Authentifizierung. Das Attribut des Fehlers message gibt einen Grund an.

close

close() -> None

Ausnahmen

ClientAuthenticationError

Fehler bei der Authentifizierung. Das Attribut des Fehlers message gibt einen Grund an.

get_token

Fordern Sie ein Zugriffstoken für Bereiche an.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parameter

scopes

str

Erforderlich

gewünschte Bereiche für das Zugriffstoken. Für diese Methode ist mindestens ein Bereich erforderlich. Weitere Informationen zu Bereichen finden Sie unter https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

Zusätzliche Ansprüche, die im Token erforderlich sind, z. B. solche, die in der Anspruchsanforderung eines Ressourcenanbieters nach einem Autorisierungsfehler zurückgegeben werden

tenant_id

str

optionaler Mandant, der in die Tokenanforderung aufgenommen werden soll.

enable_cae

bool

gibt an, ob die fortlaufende Zugriffsauswertung (Continuous Access Evaluation, CAE) für das angeforderte Token aktiviert werden soll. Der Standardwert lautet „False“.

Gibt zurück

Ein Zugriffstoken mit den gewünschten Bereichen.

Rückgabetyp

AccessToken

Ausnahmen

CredentialUnavailableError

Die Anmeldeinformationen können nicht versucht werden, die Authentifizierung zu versuchen, da die erforderlichen Daten, der Status oder die Plattform nicht unterstützt werden.

ClientAuthenticationError

Fehler bei der Authentifizierung. Das Attribut des Fehlers message gibt einen Grund an.

AuthenticationRequiredError

Benutzerinteraktionen sind erforderlich, um ein Token abzurufen, und die Anmeldeinformationen sind so konfiguriert, dass sie nicht automatisch beginnen. Aufruf

authenticate

, um mit der interaktiven Authentifizierung zu beginnen.