EnvironmentCredential Třída

  • Reference

Přihlašovací údaje nakonfigurované proměnnými prostředí.

Tyto přihlašovací údaje se mohou ověřovat jako instanční objekt pomocí tajného klíče klienta nebo certifikátu nebo jako uživatel s uživatelským jménem a heslem. Konfigurace se provádí v tomto pořadí s použitím těchto proměnných prostředí:

Instanční objekt s tajným kódem:

  • AZURE_TENANT_ID: ID tenanta instančního objektu. Označuje se také jako ID adresáře.

  • AZURE_CLIENT_ID: ID klienta instančního objektu

  • AZURE_CLIENT_SECRET: Jeden z tajných klíčů klienta instančního objektu

  • AZURE_AUTHORITY_HOST: autorita koncového bodu Azure Active Directory, například "login.microsoftonline.com", autorita pro veřejný cloud Azure, která je výchozí, když se nezadá žádná hodnota.

Instanční objekt s certifikátem:

  • AZURE_TENANT_ID: ID tenanta instančního objektu. Označuje se také jako ID adresáře.

  • AZURE_CLIENT_ID: ID klienta instančního objektu

  • AZURE_CLIENT_CERTIFICATE_PATH: Cesta k souboru certifikátu PEM nebo PKCS12 včetně privátního klíče.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (volitelné) heslo souboru certifikátu, pokud existuje.

  • AZURE_AUTHORITY_HOST: autorita koncového bodu Azure Active Directory, například "login.microsoftonline.com", autorita pro veřejný cloud Azure, která je výchozí, když se nezadá žádná hodnota.

Uživatel s uživatelským jménem a heslem:

  • AZURE_CLIENT_ID: ID klienta aplikace

  • AZURE_USERNAME: uživatelské jméno (obvykle e-mailová adresa)

  • AZURE_PASSWORD: heslo daného uživatele

  • AZURE_TENANT_ID: (volitelné) ID tenanta instančního objektu. Označuje se také jako ID adresáře. Pokud ji nezadáte, nastaví se jako výchozí tenant organizace, který podporuje jenom pracovní nebo školní účty Azure Active Directory.

  • AZURE_AUTHORITY_HOST: autorita koncového bodu Azure Active Directory, například "login.microsoftonline.com", autorita pro veřejný cloud Azure, která je výchozí, když se nezadá žádná hodnota.

Dědičnost
builtins.object
EnvironmentCredential

Konstruktor

EnvironmentCredential(**kwargs: Any)

Příklady

Vytvořte přihlašovací údaje prostředí.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Metody

close

Zavřete přenosovou relaci přihlašovacích údajů.
get_token

Vyžádejte si přístupový token pro obory.

Klienti sady Azure SDK volali tuto metodu automaticky.

close

Zavřete přenosovou relaci přihlašovacích údajů.

close() -> None

get_token

Vyžádejte si přístupový token pro obory.

Klienti sady Azure SDK volali tuto metodu automaticky.

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

Parametry

scopes
str
Vyžadováno

požadované obory přístupového tokenu. Tato metoda vyžaduje alespoň jeden obor. Další informace o oborech najdete v tématu https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

Další deklarace identity vyžadované v tokenu, například ty, které se vrací při výzvě k deklaraci identity poskytovatele prostředků po selhání autorizace.

tenant_id
str

volitelného tenanta, který se má zahrnout do žádosti o token.

Návraty

Přístupový token s požadovanými obory.

Návratový typ

AccessToken

Výjimky

CredentialUnavailableError

Konfigurace proměnné prostředí je neúplná