AzureDeveloperCliCredential Kelas

Mengautentikasi dengan meminta token dari Azure Developer CLI.

Azure Developer CLI adalah alat antarmuka baris perintah yang memungkinkan pengembang membuat, mengelola, dan menyebarkan sumber daya di Azure. Ini dibangun di atas Azure CLI dan menyediakan fungsionalitas tambahan khusus untuk pengembang Azure. Ini memungkinkan pengguna untuk mengautentikasi sebagai pengguna dan/atau perwakilan layanan terhadap Azure Active Directory (Azure AD). AzureDeveloperCliCredential mengautentikasi di lingkungan pengembangan dan memperoleh token atas nama pengguna atau perwakilan layanan yang masuk di Azure Developer CLI. Ini bertindak sebagai pengguna atau perwakilan layanan yang masuk Azure Developer CLI dan menjalankan perintah Azure CLI di bawahnya untuk mengautentikasi aplikasi terhadap Azure Active Directory.

Untuk menggunakan kredensial ini, pengembang perlu mengautentikasi secara lokal dalam Azure Developer CLI menggunakan salah satu perintah di bawah ini:

• Jalankan "azd auth login" di Azure Developer CLI untuk mengautentikasi secara interaktif sebagai pengguna.

• Jalankan "azd auth login –client-id 'client_id' –client-secret 'client_secret' –tenant-id 'tenant_id'" untuk mengautentikasi sebagai perwakilan layanan.

Anda mungkin perlu mengulangi proses ini setelah jangka waktu tertentu, tergantung pada validitas token refresh di organisasi Anda. Umumnya, masa berlaku token refresh adalah beberapa minggu hingga beberapa bulan. AzureDeveloperCliCredential akan meminta Anda untuk masuk lagi.

Warisan

builtins.object

AzureDeveloperCliCredential

Konstruktor

AzureDeveloperCliCredential(*, tenant_id: str = '', additionally_allowed_tenants: List[str] | None = None, process_timeout: int = 10)

Parameter

tenant_id

str

Penyewa opsional untuk disertakan dalam permintaan token.

additionally_allowed_tenants

List[str]

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.

process_timeout

int

Detik untuk menunggu proses Azure Developer CLI merespons. Default hingga 10 detik.

Contoh

Buat AzureDeveloperCliCredential.

   from azure.identity import AzureDeveloperCliCredential

   credential = AzureDeveloperCliCredential()

Metode

close	Memanggil metode ini tidak perlu.
get_token	Meminta token akses untuk cakupan. Metode ini dipanggil secara otomatis oleh klien Azure SDK. Aplikasi yang memanggil metode ini secara langsung juga harus menangani penembolokan token karena kredensial ini tidak menyimpan token yang diperolehnya.

close

Memanggil metode ini tidak perlu.

close() -> None

get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK. Aplikasi yang memanggil metode ini secara langsung juga harus menangani penembolokan token karena kredensial ini tidak menyimpan token yang diperolehnya.

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. Kredensial ini hanya memungkinkan satu cakupan per permintaan. Untuk informasi selengkapnya tentang cakupan, lihat https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

tidak digunakan oleh kredensial ini; nilai apa pun yang disediakan akan diabaikan.

tenant_id

str

penyewa opsional untuk disertakan dalam permintaan token.

Mengembalikan

Token akses dengan cakupan yang diinginkan.

Tipe hasil

AccessToken

Pengecualian

CredentialUnavailableError

kredensial tidak dapat memanggil Azure Developer CLI.

ClientAuthenticationError

kredensial memanggil Azure Developer CLI tetapi tidak menerima token akses.