Freigeben über

ClientSecretCredential Klasse

  • Referenz

Authentifiziert sich als Dienstprinzipal mithilfe eines geheimen Clientschlüssels.

Vererbung
azure.identity._internal.client_credential_base.ClientCredentialBase
ClientSecretCredential

Konstruktor

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)

Parameter

tenant_id
str
Erforderlich

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

client_id
str
Erforderlich

Die Client-ID des Dienstprinzipals

client_secret
str
Erforderlich

Eines der Clientgeheimnisse des Dienstprinzipals

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.

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 ein ClientSecretCredential-Objekt.


   from azure.identity import ClientSecretCredential

   credential = ClientSecretCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
   )

Methoden

close
get_token

Fordern Sie ein Zugriffstoken für Bereiche an.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

close 

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.

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.