CertificateCredential Kelas
Mengautentikasi sebagai perwakilan layanan menggunakan sertifikat.
Sertifikat harus memiliki kunci privat RSA, karena kredensial ini menandatangani pernyataan menggunakan RS256. Lihat Dokumentasi Azure Active Directory untuk informasi selengkapnya tentang mengonfigurasi autentikasi sertifikat.
- Warisan
-
azure.identity._internal.client_credential_base.ClientCredentialBaseCertificateCredential
Konstruktor
CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **kwargs: Any)
Parameter
- certificate_path
- str
Jalur opsional ke file sertifikat dalam format PEM atau PKCS12, termasuk kunci privat. Jika tidak disediakan, certificate_data diperlukan.
- 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.
- certificate_data
- bytes
Byte sertifikat dalam format PEM atau PKCS12, termasuk kunci privat
Kata sandi sertifikat. Jika string unicode, string tersebut akan dikodekan sebagai UTF-8. Jika sertifikat memerlukan pengodean yang berbeda, lewati byte yang dikodekan dengan tepat sebagai gantinya.
- send_certificate_chain
- bool
Jika True, kredensial akan mengirim rantai sertifikat publik di header x5c dari setiap JWT permintaan token. Ini diperlukan untuk autentikasi Nama Subjek/Penerbit (SNI). Default ke False.
- 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 CertificateCredential.
from azure.identity import CertificateCredential
credential = CertificateCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
certificate_path="<path to PEM/PKCS12 certificate>",
password="<certificate password if necessary>",
)
# Certificate/private key byte data can also be passed directly
credential = CertificateCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
certificate_data=b"<cert data>",
)
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 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
Pengecualian
kredensial tidak dapat mencoba autentikasi karena tidak memiliki data, status, atau dukungan platform yang diperlukan
autentikasi gagal. Atribut kesalahan message
memberikan alasan.