Dela via

EnvironmentCredential Klass

  • Referens

En autentiseringsuppgift som konfigurerats av miljövariabler.

Den här autentiseringsuppgiften kan autentiseras som tjänstens huvudnamn med hjälp av en klienthemlighet eller ett certifikat, eller som en användare med ett användarnamn och lösenord. Konfigurationen görs i den här ordningen med hjälp av följande miljövariabler:

Tjänstens huvudnamn med hemlighet:

  • AZURE_TENANT_ID: ID för tjänstens huvudnamns klientorganisation. Kallas även dess katalog-ID.

  • AZURE_CLIENT_ID: tjänstens huvudnamns klient-ID

  • AZURE_CLIENT_SECRET: en av tjänstens huvudnamns klienthemligheter

  • AZURE_AUTHORITY_HOST: utfärdare av en Azure Active Directory-slutpunkt, till exempel "login.microsoftonline.com", utfärdaren för Azure Public Cloud, som är standard när inget värde anges.

Tjänstens huvudnamn med certifikat:

  • AZURE_TENANT_ID: ID för tjänstens huvudnamns klientorganisation. Kallas även dess katalog-ID.

  • AZURE_CLIENT_ID: tjänstens huvudnamns klient-ID

  • AZURE_CLIENT_CERTIFICATE_PATH: sökväg till en PEM- eller PKCS12-certifikatfil inklusive den privata nyckeln.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (valfritt) lösenord för certifikatfilen, om det finns något.

  • AZURE_AUTHORITY_HOST: utfärdare av en Azure Active Directory-slutpunkt, till exempel "login.microsoftonline.com", utfärdaren för Azure Public Cloud, som är standard när inget värde anges.

Användare med användarnamn och lösenord:

  • AZURE_CLIENT_ID: programmets klient-ID

  • AZURE_USERNAME: ett användarnamn (vanligtvis en e-postadress)

  • AZURE_PASSWORD: användarens lösenord

  • AZURE_TENANT_ID: (valfritt) ID för tjänstens huvudnamns klientorganisation. Kallas även dess katalog-ID. Om det inte anges används standardinställningen "organisationer"-klientorganisationen, som endast stöder Arbets- eller skolkonton i Azure Active Directory.

  • AZURE_AUTHORITY_HOST: utfärdare av en Azure Active Directory-slutpunkt, till exempel "login.microsoftonline.com", utfärdaren för Azure Public Cloud, som är standard när inget värde anges.

Arv
builtins.object
EnvironmentCredential

Konstruktor

EnvironmentCredential(**kwargs: Any)

Exempel

Skapa en EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Metoder

close

Stäng transportsessionen för autentiseringsuppgifterna.
get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter.

close

Stäng transportsessionen för autentiseringsuppgifterna.

close() -> None

get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter.

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

Parametrar

scopes
str
Obligatorisk

önskade omfång för åtkomsttoken. Den här metoden kräver minst ett omfång. Mer information om omfång finns i https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

ytterligare anspråk som krävs i token, till exempel de som returneras i en resursproviders anspråksutmaning efter ett auktoriseringsfel.

tenant_id
str

valfri klientorganisation som ska ingå i tokenbegäran.

Returer

En åtkomsttoken med önskade omfång.

Returtyp

AccessToken

Undantag

CredentialUnavailableError

konfigurationen av miljövariabler är ofullständig