Bagikan melalui

DefaultAzureCredential Kelas

  • Referensi

Kredensial default yang mampu menangani sebagian besar skenario autentikasi Azure SDK.

Identitas yang digunakannya tergantung pada lingkungan. Saat token akses diperlukan, token tersebut memintanya menggunakan identitas ini secara bergiliran, berhenti saat seseorang menyediakan token:

  1. Perwakilan layanan yang dikonfigurasi oleh variabel lingkungan. Lihat EnvironmentCredential untuk detail selengkapnya.

  2. WorkloadIdentityCredential jika konfigurasi variabel lingkungan diatur oleh webhook identitas beban kerja Azure.

  3. Identitas terkelola Azure. Lihat ManagedIdentityCredential untuk detail selengkapnya.

  4. Hanya di Windows: pengguna yang telah masuk dengan aplikasi Microsoft, seperti Visual Studio. Jika beberapa identitas berada di cache, maka nilai variabel AZURE_USERNAME lingkungan digunakan untuk memilih identitas mana yang akan digunakan. Lihat SharedTokenCacheCredential untuk detail selengkapnya.

  5. Identitas saat ini masuk ke Azure CLI.

  6. Identitas saat ini masuk ke Azure PowerShell.

  7. Identitas saat ini masuk ke Azure Developer CLI.

Perilaku default ini dapat dikonfigurasi dengan argumen kata kunci.

Warisan
azure.identity._credentials.chained.ChainedTokenCredential
DefaultAzureCredential

Konstruktor

DefaultAzureCredential(**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. Identitas terkelola mengabaikan ini karena mereka berada di satu cloud.

exclude_workload_identity_credential
bool

Apakah akan mengecualikan identitas beban kerja dari kredensial. Default ke False.

exclude_developer_cli_credential
bool

Apakah akan mengecualikan Azure Developer CLI dari kredensial. Default ke False.

exclude_cli_credential
bool

Apakah akan mengecualikan Azure CLI dari kredensial. Default ke False.

exclude_environment_credential
bool

Apakah akan mengecualikan perwakilan layanan yang dikonfigurasi oleh variabel lingkungan dari kredensial. Default ke False.

exclude_managed_identity_credential
bool

Apakah akan mengecualikan identitas terkelola dari kredensial. Default ke False.

exclude_powershell_credential
bool

Apakah akan mengecualikan Azure PowerShell. Default ke False.

exclude_visual_studio_code_credential
bool

Apakah akan mengecualikan kredensial tersimpan dari Visual Studio Code. Default ke True.

exclude_shared_token_cache_credential
bool

Apakah akan mengecualikan cache token bersama. Default ke False.

exclude_interactive_browser_credential
bool

Apakah akan mengecualikan autentikasi browser interaktif (lihat InteractiveBrowserCredential). Default ke True.

interactive_browser_tenant_id
str

ID Penyewa untuk digunakan saat mengautentikasi pengguna melalui InteractiveBrowserCredential. Default ke nilai variabel lingkungan AZURE_TENANT_ID, jika ada. Jika tidak ditentukan, pengguna akan mengautentikasi di penyewa rumah mereka.

managed_identity_client_id
str

ID klien identitas terkelola yang ditetapkan pengguna. Default ke nilai variabel lingkungan AZURE_CLIENT_ID, jika ada. Jika tidak ditentukan, identitas yang ditetapkan sistem akan digunakan.

workload_identity_client_id
str

ID klien dari identitas yang ditetapkan ke pod. Default ke nilai variabel lingkungan AZURE_CLIENT_ID, jika ada. Jika tidak ditentukan, identitas default pod akan digunakan.

workload_identity_tenant_id
str

Penyewa pilihan untuk WorkloadIdentityCredential. Default ke nilai variabel lingkungan AZURE_TENANT_ID, jika ada.

interactive_browser_client_id
str

ID klien yang akan digunakan dalam kredensial browser interaktif. Jika tidak ditentukan, pengguna akan mengautentikasi ke aplikasi pengembangan Azure.

shared_cache_username
str

Nama pengguna pilihan untuk SharedTokenCacheCredential. Default ke nilai variabel lingkungan AZURE_USERNAME, jika ada.

shared_cache_tenant_id
str

Penyewa pilihan untuk SharedTokenCacheCredential. Default ke nilai variabel lingkungan AZURE_TENANT_ID, jika ada.

visual_studio_code_tenant_id
str

ID penyewa untuk digunakan saat mengautentikasi dengan VisualStudioCodeCredential. Default ke pengaturan "Azure: Penyewa" di pengaturan pengguna Visual Studio Code atau, saat pengaturan tersebut tidak memiliki nilai, penyewa "organisasi", yang hanya mendukung akun kerja atau sekolah Azure Active Directory.

process_timeout
int

Batas waktu dalam detik yang digunakan untuk kredensial pengembang yang menjalankan subproses (misalnya AzureCliCredential, AzurePowerShellCredential). Default ke 10 detik.

Contoh

Buat DefaultAzureCredential.


   from azure.identity import DefaultAzureCredential

   credential = DefaultAzureCredential()

Metode

close

Tutup sesi transportasi setiap kredensial dalam rantai.
get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

close

Tutup sesi transportasi setiap kredensial dalam rantai.

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.

Mengembalikan

Token akses dengan cakupan yang diinginkan.

Tipe hasil

AccessToken

Pengecualian

ClientAuthenticationError

autentikasi gagal. Pengecualian memiliki atribut pesan yang mencantumkan setiap upaya autentikasi dan pesan kesalahannya.