Share via

EnvironmentCredential Kelas

  • Referensi

Kredensial yang dikonfigurasi oleh variabel lingkungan.

Kredensial ini mampu mengautentikasi sebagai perwakilan layanan menggunakan rahasia klien atau sertifikat, atau sebagai pengguna dengan nama pengguna dan kata sandi. Konfigurasi dicoba dalam urutan ini, menggunakan variabel lingkungan ini:

Perwakilan layanan dengan rahasia:

  • AZURE_TENANT_ID: ID penyewa perwakilan layanan. Juga disebut ID 'direktori'.

  • AZURE_CLIENT_ID: ID klien perwakilan layanan

  • AZURE_CLIENT_SECRET: salah satu rahasia klien perwakilan layanan

  • AZURE_AUTHORITY_HOST: otoritas titik akhir Azure Active Directory, misalnya "login.microsoftonline.com", otoritas untuk Azure Public Cloud, yang merupakan default ketika tidak ada nilai yang diberikan.

Perwakilan layanan dengan sertifikat:

  • AZURE_TENANT_ID: ID penyewa perwakilan layanan. Juga disebut ID 'direktori'.

  • AZURE_CLIENT_ID: ID klien perwakilan layanan

  • AZURE_CLIENT_CERTIFICATE_PATH: jalur ke file sertifikat PEM atau PKCS12 termasuk kunci privat.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opsional) kata sandi file sertifikat, jika ada.

  • AZURE_AUTHORITY_HOST: otoritas titik akhir Azure Active Directory, misalnya "login.microsoftonline.com", otoritas untuk Azure Public Cloud, yang merupakan default ketika tidak ada nilai yang diberikan.

Pengguna dengan nama pengguna dan kata sandi:

  • AZURE_CLIENT_ID: ID klien aplikasi

  • AZURE_USERNAME: nama pengguna (biasanya alamat email)

  • AZURE_PASSWORD: kata sandi pengguna tersebut

  • AZURE_TENANT_ID: (opsional) ID penyewa perwakilan layanan. Juga disebut ID 'direktori'. Jika tidak disediakan, default ke penyewa 'organisasi', yang hanya mendukung akun kerja atau sekolah Azure Active Directory.

  • AZURE_AUTHORITY_HOST: otoritas titik akhir Azure Active Directory, misalnya "login.microsoftonline.com", otoritas untuk Azure Public Cloud, yang merupakan default ketika tidak ada nilai yang diberikan.

Warisan
builtins.object
EnvironmentCredential

Konstruktor

EnvironmentCredential(**kwargs: Any)

Contoh

Buat EnvironmentCredential.


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

Metode

close

Tutup sesi transportasi kredensial.
get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

close

Tutup sesi transportasi kredensial.

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 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.

Mengembalikan

Token akses dengan cakupan yang diinginkan.

Tipe hasil

AccessToken

Pengecualian

CredentialUnavailableError

konfigurasi variabel lingkungan tidak lengkap