ClientSecretCredential Kelas
Mengautentikasi sebagai perwakilan layanan menggunakan rahasia klien.
- Warisan
-
azure.identity._internal.client_credential_base.ClientCredentialBaseClientSecretCredential
Konstruktor
ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)
Parameter
- authority
- str
Otoritas titik akhir Azure Active Directory, misalnya "login.microsoftonline.com", otoritas untuk Azure Public Cloud (yang merupakan default). AzureAuthorityHosts mendefinisikan otoritas untuk cloud lain.
- cache_persistence_options
- TokenCachePersistenceOptions
Konfigurasi untuk penembolokan token persisten. Jika tidak ditentukan, kredensial akan menyimpan token dalam memori.
- disable_instance_discovery
- bool
Menentukan apakah penemuan instans dilakukan atau tidak saat mencoba mengautentikasi. Mengatur ini ke true akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Fungsionalitas ini ditujukan untuk digunakan dalam skenario di mana titik akhir metadata tidak dapat dicapai, seperti di cloud privat atau Azure Stack. Proses penemuan instans memerlukan pengambilan metadata otoritas dari https://login.microsoft.com/ untuk memvalidasi otoritas. Dengan mengatur ini ke True, validasi otoritas dinonaktifkan. Akibatnya, sangat penting untuk memastikan bahwa host otoritas yang dikonfigurasi valid dan dapat dipercaya.
Menentukan penyewa selain "tenant_id" yang ditentukan yang kredensialnya dapat memperoleh token. Tambahkan nilai kartubebas "*" untuk memungkinkan kredensial memperoleh token untuk penyewa mana pun yang dapat diakses aplikasi.
Contoh
Buat ClientSecretCredential.
from azure.identity import ClientSecretCredential
credential = ClientSecretCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
client_secret="<client_secret>",
)
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
cakupan yang diinginkan untuk token akses. Metode ini membutuhkan 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
Pengecualian
kredensial tidak dapat mencoba autentikasi karena tidak memiliki data, status, atau dukungan platform yang diperlukan
autentikasi gagal. Atribut kesalahan message
memberikan alasan.
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk