WorkloadIdentityCredential Třída

  • Reference

Ověřuje se pomocí identity úlohy Azure Active Directory.

Ověřování identit úloh je funkce v Azure, která aplikacím běžícím na virtuálních počítačích umožňuje přístup k jiným prostředkům Azure bez nutnosti instančního objektu nebo spravované identity. Při ověřování identit úloh se aplikace ověřují pomocí vlastní identity, nikoli pomocí sdíleného instančního objektu nebo spravované identity. Ověřování identit úloh používá koncept přihlašovacích údajů účtu služby (SAC), které automaticky vytváří Azure a bezpečně se ukládají na virtuálním počítači. Pomocí ověřování identit úloh se můžete vyhnout nutnosti spravovat a obměňovat instanční objekty nebo spravované identity pro každou aplikaci na jednotlivých virtuálních počítačích. Vzhledem k tomu, že služby SAC se vytvářejí automaticky a spravují v Azure, nemusíte se navíc starat o ukládání a zabezpečení citlivých přihlašovacích údajů.

WorkloadIdentityCredential podporuje ověřování identit úloh Azure v Azure Kubernetes a získá token pomocí přihlašovacích údajů účtu služby dostupných v prostředí Azure Kubernetes. Další informace najdete v tomto přehledu identit úloh .

Dědičnost
azure.identity._credentials.client_assertion.ClientAssertionCredential
WorkloadIdentityCredential
azure.identity._credentials.workload_identity.TokenFileMixin
WorkloadIdentityCredential

Konstruktor

WorkloadIdentityCredential(*, tenant_id: str | None = None, client_id: str | None = None, token_file_path: str | None = None, **kwargs: Any)

Parametry

tenant_id
str

ID tenanta Azure Active Directory aplikace Označuje se také jako ID adresáře.

client_id
str

ID klienta registrace aplikace Azure AD.

token_file_path
str

Cesta k souboru obsahujícímu token účtu služby Kubernetes, který ověřuje identitu.

Příklady

Vytvořte WorkloadIdentityCredential.


   from azure.identity import WorkloadIdentityCredential

   credential = WorkloadIdentityCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       token_file_path="<token_file_path>",
   )

   # Parameters can be omitted if the following environment variables are set:
   #   - AZURE_TENANT_ID
   #   - AZURE_CLIENT_ID
   #   - AZURE_FEDERATED_TOKEN_FILE
   credential = WorkloadIdentityCredential()

Metody

close
get_token

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

Klienti sady Azure SDK tuto metodu volali automaticky.

close 

close() -> None

get_token

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

Klienti sady Azure SDK tuto metodu volali 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 pro přístupový token. Tato metoda vyžaduje alespoň jeden obor. Další informace o oborech najdete v tématu https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc.

claims
str

další deklarace identity vyžadované v tokenu, například ty, které se vrátí při napadení deklarací identity poskytovatele prostředků po selhání autorizace.

tenant_id
str

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

enable_cae
bool

určuje, jestli se má pro požadovaný token povolit průběžné vyhodnocování přístupu (CAE). Výchozí hodnota je False.

Návraty

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

Návratový typ

AccessToken

Výjimky

CredentialUnavailableError

přihlašovací údaje se nemohou pokusit o ověření, protože nemají požadovaná data, stav nebo podporu platformy.

ClientAuthenticationError

ověřování se nezdařilo. Atribut chyby message uvádí důvod.