WorkloadIdentityCredential Třída

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

Ověřování identit úloh je funkce v Azure, která umožňuje aplikacím běžícím na virtuálních počítačích přistupovat k další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, a ne 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é se automaticky vytvářejí v 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 každém virtuálním počítači. Vzhledem k tomu, že se přidružení zabezpečení vytváří automaticky a spravuje je Azure, nemusíte si dělat starosti s ukládáním a zabezpečením citlivých přihlašovacích údajů.

WorkloadIdentityCredential podporuje ověřování identit úloh Azure v Azure Kubernetes a získává 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.aio._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.aio 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	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ů.

async close() -> None

get_token

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

Klienti sady Azure SDK volali tuto metodu automaticky.

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

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 nemůžou pokusit o ověření, protože jim chybí požadovaná data, stav nebo podpora platformy

ClientAuthenticationError

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