Share via

EnvironmentCredential Klasse

  • Referenz

Anmeldeinformationen, die durch Umgebungsvariablen konfiguriert sind.

Diese Anmeldeinformationen können sich als Dienstprinzipal mithilfe eines geheimen Clientschlüssels oder zertifikats oder als Benutzer mit Benutzername und Kennwort authentifizieren. Die Konfiguration wird in dieser Reihenfolge mithilfe der folgenden Umgebungsvariablen versucht:

Dienstprinzipal mit Geheimnis:

  • AZURE_TENANT_ID: ID des Mandanten des Dienstprinzipals. Wird auch als "Verzeichnis"-ID bezeichnet.

  • AZURE_CLIENT_ID: Die Client-ID des Dienstprinzipals

  • AZURE_CLIENT_SECRET: eines der Clientgeheimnisse des Dienstprinzipals

  • AZURE_AUTHORITY_HOST: Autorität eines Azure Active Directory-Endpunkts, z. B. "login.microsoftonline.com", der Autorität für Azure Public Cloud. Dies ist die Standardeinstellung, wenn kein Wert angegeben wird.

Dienstprinzipal mit Zertifikat:

  • AZURE_TENANT_ID: ID des Mandanten des Dienstprinzipals. Wird auch als "Verzeichnis"-ID bezeichnet.

  • AZURE_CLIENT_ID: Die Client-ID des Dienstprinzipals

  • AZURE_CLIENT_CERTIFICATE_PATH: Pfad zu einer PEM- oder PKCS12-Zertifikatdatei einschließlich des privaten Schlüssels.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (optional) Kennwort der Zertifikatdatei, falls vorhanden.

  • AZURE_AUTHORITY_HOST: Autorität eines Azure Active Directory-Endpunkts, z. B. "login.microsoftonline.com", der Autorität für Azure Public Cloud. Dies ist die Standardeinstellung, wenn kein Wert angegeben wird.

Benutzer mit Benutzername und Kennwort:

  • AZURE_CLIENT_ID: Die Client-ID der Anwendung

  • AZURE_USERNAME: Ein Benutzername (in der Regel eine E-Mail-Adresse)

  • AZURE_PASSWORD: Das Kennwort dieses Benutzers

  • AZURE_TENANT_ID: (optional) ID des Mandanten des Dienstprinzipals. Wird auch als "Verzeichnis"-ID bezeichnet. Wenn nicht angegeben, wird standardmäßig der Mandant "Organisationen" verwendet, der nur Azure Active Directory-Geschäfts- oder Schulkonten unterstützt.

  • AZURE_AUTHORITY_HOST: Autorität eines Azure Active Directory-Endpunkts, z. B. "login.microsoftonline.com", der Autorität für Azure Public Cloud. Dies ist die Standardeinstellung, wenn kein Wert angegeben wird.

Vererbung
builtins.object
EnvironmentCredential

Konstruktor

EnvironmentCredential(**kwargs: Any)

Beispiele

Erstellen Sie ein EnvironmentCredential-Objekt.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Methoden

close

Schließen Sie die Transportsitzung der Anmeldeinformationen.
get_token

Fordern Sie ein Zugriffstoken für Bereiche an.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

close

Schließen Sie die Transportsitzung der Anmeldeinformationen.

close() -> None

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. die in der Anspruchsanforderung eines Ressourcenanbieters nach einem Autorisierungsfehler zurückgegeben werden.

tenant_id
str

optionaler Mandant, der in die Tokenanforderung aufgenommen werden soll.

Gibt zurück

Ein Zugriffstoken mit den gewünschten Bereichen.

Rückgabetyp

AccessToken

Ausnahmen

CredentialUnavailableError

Die Konfiguration der Umgebungsvariablen ist unvollständig.