SharedTokenCacheCredential Klasse

Authentifizierung mit Token in dem von Microsoft-Anwendungen gemeinsam genutzten lokalen Cache.

Vererbung

azure.identity._internal.shared_token_cache.SharedTokenCacheBase

SharedTokenCacheCredential

azure.identity.aio._internal.AsyncContextManager

SharedTokenCacheCredential

Konstruktor

SharedTokenCacheCredential(username: str | None = None, *, authority: str | None = None, tenant_id: str | None = None, **kwargs: Any)

Parameter

username

str

Standardwert: None

Benutzername (in der Regel eine E-Mail-Adresse) des Benutzers, als der sich authentifizieren soll. Dies ist erforderlich, da der lokale Cache Token für mehrere Identitäten enthalten kann.

authority

str

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

tenant_id

str

eine Azure Active Directory-Mandanten-ID. Wird verwendet, um ein Konto auszuwählen, wenn der Cache Token für mehrere Identitäten enthält.

cache_persistence_options

TokenCachePersistenceOptions

Konfiguration für die persistente Tokenzwischenspeicherung. Falls nicht angegeben, verwenden die Anmeldeinformationen den von Microsoft-Entwicklungsanwendungen freigegebenen persistenten Cache.

Methoden

close	Schließen Sie die Transportsitzung der Anmeldeinformationen.
get_token	Abrufen eines Zugriffstokens für Bereiche aus dem freigegebenen Cache. Wenn kein Zugriffstoken zwischengespeichert wird, versuchen Sie, eins mithilfe eines zwischengespeicherten Aktualisierungstokens abzurufen. Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.
supported	Gibt an, ob der freigegebene Tokencache auf der aktuellen Plattform unterstützt wird.

close

Schließen Sie die Transportsitzung der Anmeldeinformationen.

async close() -> None

get_token

Abrufen eines Zugriffstokens für Bereiche aus dem freigegebenen Cache.

Wenn kein Zugriffstoken zwischengespeichert wird, versuchen Sie, eins mithilfe eines zwischengespeicherten Aktualisierungstokens abzurufen.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

async 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 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

Der Cache ist nicht verfügbar oder enthält unzureichende Benutzerinformationen.

ClientAuthenticationError

Fehler bei der Authentifizierung. Das Attribut des Fehlers message gibt einen Grund an. Alle Fehlerantworten von Azure Active Directory sind als Attribut des Fehlers response verfügbar.

supported

Gibt an, ob der freigegebene Tokencache auf der aktuellen Plattform unterstützt wird.

static supported() -> bool

Gibt zurück

True, wenn der freigegebene Tokencache auf der aktuellen Plattform unterstützt wird.

Rückgabetyp

bool