Share via

WorkloadIdentityCredential Kelas

  • Referensi

Mengautentikasi menggunakan identitas beban kerja Azure Active Directory.

Autentikasi identitas beban kerja adalah fitur di Azure yang memungkinkan aplikasi yang berjalan pada komputer virtual (VM) untuk mengakses sumber daya Azure lainnya tanpa memerlukan perwakilan layanan atau identitas terkelola. Dengan autentikasi identitas beban kerja, aplikasi mengautentikasi diri mereka sendiri menggunakan identitas mereka sendiri, daripada menggunakan perwakilan layanan bersama atau identitas terkelola. Di bawah tenda, autentikasi identitas beban kerja menggunakan konsep Kredensial Akun Layanan (SAC), yang secara otomatis dibuat oleh Azure dan disimpan dengan aman di VM. Dengan menggunakan autentikasi identitas beban kerja, Anda dapat menghindari kebutuhan untuk mengelola dan memutar perwakilan layanan atau identitas terkelola untuk setiap aplikasi pada setiap VM. Selain itu, karena SAC dibuat secara otomatis dan dikelola oleh Azure, Anda tidak perlu khawatir tentang menyimpan dan mengamankan kredensial sensitif itu sendiri.

WorkloadIdentityCredential mendukung autentikasi identitas beban kerja Azure di Azure Kubernetes dan memperoleh token menggunakan kredensial akun layanan yang tersedia di lingkungan Azure Kubernetes. Lihat ringkasan identitas beban kerja ini untuk informasi selengkapnya.

Warisan
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)

Parameter

tenant_id
str

ID dari penyewa Azure Active Directory aplikasi. Juga disebut ID "direktori".

client_id
str

ID klien pendaftaran aplikasi Azure AD.

token_file_path
str

Jalur ke file yang berisi token akun layanan Kubernetes yang mengautentikasi identitas.

Contoh

Membuat 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()

Metode

close
get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

close 

close() -> None

get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

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

Parameter

scopes
str
Diperlukan

cakupan yang diinginkan untuk token akses. Metode ini memerlukan setidaknya satu cakupan. Untuk informasi selengkapnya tentang cakupan, lihat https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

klaim tambahan yang diperlukan dalam token, seperti yang dikembalikan dalam tantangan klaim penyedia sumber daya setelah kegagalan otorisasi.

tenant_id
str

penyewa opsional untuk disertakan dalam permintaan token.

enable_cae
bool

menunjukkan apakah akan mengaktifkan Evaluasi Akses Berkelanjutan (CAE) untuk token yang diminta. Default ke False.

Mengembalikan

Token akses dengan cakupan yang diinginkan.

Tipe hasil

AccessToken

Pengecualian

CredentialUnavailableError

kredensial tidak dapat mencoba autentikasi karena tidak memiliki data, status, atau dukungan platform yang diperlukan

ClientAuthenticationError

autentikasi gagal. Atribut kesalahan message memberikan alasan.