Bagikan melalui

EnvironmentCredential class

Paket:
@azure/identity

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan rahasia atau sertifikat klien.

Konstruktor

EnvironmentCredential(EnvironmentCredentialOptions)

Membuat instans kelas EnvironmentCredential dan memutuskan kredensial apa yang akan digunakan tergantung pada variabel lingkungan yang tersedia.

Variabel lingkungan yang diperlukan:

  • AZURE_TENANT_ID: ID penyewa (direktori) Microsoft Entra.
  • AZURE_CLIENT_ID: ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.

Jika mengatur AZURE_TENANT_ID, Maka Anda juga dapat mengatur penyewa yang diizinkan tambahan

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Untuk aplikasi multi-penyewa, menentukan penyewa tambahan yang kredensialnya dapat memperoleh token dengan satu string yang dibatasi titik koma. Gunakan * untuk mengizinkan semua penyewa.

Variabel lingkungan yang digunakan untuk autentikasi kredensial klien:

  • AZURE_CLIENT_SECRET: Rahasia klien yang dihasilkan untuk Pendaftaran Aplikasi.
  • AZURE_CLIENT_CERTIFICATE_PATH: Jalur ke sertifikat PEM yang akan digunakan selama autentikasi, bukan rahasia klien.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opsional) kata sandi untuk file sertifikat.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (opsional) menunjukkan bahwa rantai sertifikat harus diatur dalam header x5c untuk mendukung autentikasi berbasis nama subjek / pengeluar sertifikat.

Autentikasi nama pengguna dan kata sandi tidak digunakan lagi, karena tidak mendukung autentikasi multifaktor (MFA). Lihat https://aka.ms/azsdk/identity/mfa untuk detail selengkapnya. Pengguna masih dapat memberikan variabel lingkungan untuk metode autentikasi ini:

  • AZURE_USERNAME: Nama pengguna untuk diautentikasi.
  • AZURE_PASSWORD: Kata sandi untuk diautentikasi.

Jika variabel lingkungan yang diperlukan untuk melakukan autentikasi hilang, CredentialUnavailableError akan dilemparkan. Jika autentikasi gagal, atau jika ada kesalahan yang tidak diketahui, AuthenticationError akan dilemparkan.

Metode

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan ID Microsoft Entra dan mengembalikan token akses jika berhasil.

Detail Konstruktor

EnvironmentCredential(EnvironmentCredentialOptions)

Membuat instans kelas EnvironmentCredential dan memutuskan kredensial apa yang akan digunakan tergantung pada variabel lingkungan yang tersedia.

Variabel lingkungan yang diperlukan:

  • AZURE_TENANT_ID: ID penyewa (direktori) Microsoft Entra.
  • AZURE_CLIENT_ID: ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.

Jika mengatur AZURE_TENANT_ID, Maka Anda juga dapat mengatur penyewa yang diizinkan tambahan

  • AZURE_ADDITIONALLY_ALLOWED_TENANTS: Untuk aplikasi multi-penyewa, menentukan penyewa tambahan yang kredensialnya dapat memperoleh token dengan satu string yang dibatasi titik koma. Gunakan * untuk mengizinkan semua penyewa.

Variabel lingkungan yang digunakan untuk autentikasi kredensial klien:

  • AZURE_CLIENT_SECRET: Rahasia klien yang dihasilkan untuk Pendaftaran Aplikasi.
  • AZURE_CLIENT_CERTIFICATE_PATH: Jalur ke sertifikat PEM yang akan digunakan selama autentikasi, bukan rahasia klien.
  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (opsional) kata sandi untuk file sertifikat.
  • AZURE_CLIENT_SEND_CERTIFICATE_CHAIN: (opsional) menunjukkan bahwa rantai sertifikat harus diatur dalam header x5c untuk mendukung autentikasi berbasis nama subjek / pengeluar sertifikat.

Autentikasi nama pengguna dan kata sandi tidak digunakan lagi, karena tidak mendukung autentikasi multifaktor (MFA). Lihat https://aka.ms/azsdk/identity/mfa untuk detail selengkapnya. Pengguna masih dapat memberikan variabel lingkungan untuk metode autentikasi ini:

  • AZURE_USERNAME: Nama pengguna untuk diautentikasi.
  • AZURE_PASSWORD: Kata sandi untuk diautentikasi.

Jika variabel lingkungan yang diperlukan untuk melakukan autentikasi hilang, CredentialUnavailableError akan dilemparkan. Jika autentikasi gagal, atau jika ada kesalahan yang tidak diketahui, AuthenticationError akan dilemparkan.

new EnvironmentCredential(options?: EnvironmentCredentialOptions)

Parameter

options
EnvironmentCredentialOptions

Opsi untuk mengonfigurasi klien yang membuat permintaan autentikasi.

Detail Metode

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan ID Microsoft Entra dan mengembalikan token akses jika berhasil.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parameter

scopes

string | string[]

Daftar cakupan yang tokennya akan memiliki akses.

options
GetTokenOptions

Parameter opsional. LihatGetTokenOptions .

Mengembalikan

Promise<AccessToken>