Share via

DeviceCodeCredentialOptions interface

  • Referensi
Paket:
@azure/identity

Menentukan opsi untuk kelas InteractiveBrowserCredential untuk Node.js.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions

Properti

clientId

ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.
tenantId

ID penyewa (direktori) Microsoft Entra.
userPromptCallback

Fungsi panggilan balik yang akan dipanggil untuk menampilkan DeviceCodeInfo kepada pengguna. Jika tidak ditetapkan, kami akan secara otomatis mencatat informasi kode perangkat dan instruksi autentikasi di konsol.

Properti yang Diwariskan

additionallyAllowedTenants

Untuk aplikasi multi-penyewa, menentukan penyewa tambahan yang kredensialnya dapat memperoleh token. Tambahkan nilai kartubebas "*" untuk memungkinkan kredensial memperoleh token untuk penyewa mana pun yang diinstal aplikasi.
additionalPolicies

Kebijakan tambahan untuk disertakan dalam alur HTTP.
allowInsecureConnection

Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS
authenticationRecord

Hasil autentikasi sebelumnya yang dapat digunakan untuk mengambil kredensial yang di-cache dari setiap akun individu. Ini perlu disediakan jika aplikasi ingin bekerja dengan lebih dari satu akun per ID Klien dan pasangan ID Penyewa.

Catatan ini dapat diambil dengan memanggil metode kredensial authenticate() , sebagai berikut:

const authenticationRecord = await credential.authenticate();
authorityHost

Host otoritas yang digunakan untuk permintaan autentikasi. Nilai yang mungkin tersedia melalui AzureAuthorityHosts. Defaultnya adalah "https://login.microsoftonline.com".
disableAutomaticAuthentication

Membuat getToken melempar jika autentikasi manual diperlukan. Pengembang perlu memanggil untuk authenticate() mengontrol kapan harus mengautentikasi secara manual.
disableInstanceDiscovery

Bidang menentukan apakah penemuan instans dilakukan saat mencoba mengautentikasi. Mengatur ini ke true akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Akibatnya, sangat penting untuk memastikan bahwa host otoritas yang dikonfigurasi valid dan dapat dipercaya. 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.
httpClient

HttpClient yang akan digunakan untuk mengirim permintaan HTTP.
loggingOptions

Memungkinkan pengguna mengonfigurasi pengaturan untuk opsi kebijakan pengelogan, memungkinkan informasi akun pengelogan dan informasi pengidentifikasi pribadi untuk dukungan pelanggan.
proxyOptions

Opsi untuk mengonfigurasi proksi untuk permintaan keluar.
redirectOptions

Opsi tentang cara respons pengalihan ditangani.
retryOptions

Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
telemetryOptions

Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.
tlsOptions

Opsi untuk mengonfigurasi autentikasi TLS
tokenCachePersistenceOptions

Opsi untuk menyediakan lapisan persistensi (jika tersedia) saat menyimpan kredensial.

Anda harus terlebih dahulu mendaftarkan plugin penyedia persistensi. Lihat paket di @azure/identity-cache-persistence NPM.

Contoh:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

Detail Properti

clientId

ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.

clientId?: string

Nilai Properti

string

tenantId

ID penyewa (direktori) Microsoft Entra.

tenantId?: string

Nilai Properti

string

userPromptCallback

Fungsi panggilan balik yang akan dipanggil untuk menampilkan DeviceCodeInfo kepada pengguna. Jika tidak ditetapkan, kami akan secara otomatis mencatat informasi kode perangkat dan instruksi autentikasi di konsol.

userPromptCallback?: DeviceCodePromptCallback

Nilai Properti

DeviceCodePromptCallback

Detail Properti yang Diwariskan

additionallyAllowedTenants

Untuk aplikasi multi-penyewa, menentukan penyewa tambahan yang kredensialnya dapat memperoleh token. Tambahkan nilai kartubebas "*" untuk memungkinkan kredensial memperoleh token untuk penyewa mana pun yang diinstal aplikasi.

additionallyAllowedTenants?: string[]

Nilai Properti

string[]

Diwarisi DariInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Kebijakan tambahan untuk disertakan dalam alur HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Nilai Properti

AdditionalPolicyConfig[]

Diwarisi DariInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS

allowInsecureConnection?: boolean

Nilai Properti

boolean

Diwarisi DariInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Hasil autentikasi sebelumnya yang dapat digunakan untuk mengambil kredensial yang di-cache dari setiap akun individu. Ini perlu disediakan jika aplikasi ingin bekerja dengan lebih dari satu akun per ID Klien dan pasangan ID Penyewa.

Catatan ini dapat diambil dengan memanggil metode kredensial authenticate() , sebagai berikut:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Nilai Properti

AuthenticationRecord

Diwarisi DariInteractiveCredentialOptions.authenticationRecord

authorityHost

Host otoritas yang digunakan untuk permintaan autentikasi. Nilai yang mungkin tersedia melalui AzureAuthorityHosts. Defaultnya adalah "https://login.microsoftonline.com".

authorityHost?: string

Nilai Properti

string

Diwarisi DariInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Membuat getToken melempar jika autentikasi manual diperlukan. Pengembang perlu memanggil untuk authenticate() mengontrol kapan harus mengautentikasi secara manual.

disableAutomaticAuthentication?: boolean

Nilai Properti

boolean

Diwarisi DariInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Bidang menentukan apakah penemuan instans dilakukan saat mencoba mengautentikasi. Mengatur ini ke true akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Akibatnya, sangat penting untuk memastikan bahwa host otoritas yang dikonfigurasi valid dan dapat dipercaya. 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.

disableInstanceDiscovery?: boolean

Nilai Properti

boolean

Diwarisi DariInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient yang akan digunakan untuk mengirim permintaan HTTP.

httpClient?: HttpClient

Nilai Properti

HttpClient

Diwarisi DariInteractiveCredentialOptions.httpClient

loggingOptions

Memungkinkan pengguna mengonfigurasi pengaturan untuk opsi kebijakan pengelogan, memungkinkan informasi akun pengelogan dan informasi pengidentifikasi pribadi untuk dukungan pelanggan.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Nilai Properti

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Diwarisi DariInteractiveCredentialOptions.loggingOptions

proxyOptions

Opsi untuk mengonfigurasi proksi untuk permintaan keluar.

proxyOptions?: ProxySettings

Nilai Properti

ProxySettings

Diwarisi DariInteractiveCredentialOptions.proxyOptions

redirectOptions

Opsi tentang cara respons pengalihan ditangani.

redirectOptions?: RedirectPolicyOptions

Nilai Properti

RedirectPolicyOptions

Diwarisi DariInteractiveCredentialOptions.redirectOptions

retryOptions

Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.

retryOptions?: PipelineRetryOptions

Nilai Properti

PipelineRetryOptions

Diwarisi DariInteractiveCredentialOptions.retryOptions

telemetryOptions

Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.

telemetryOptions?: TelemetryOptions

Nilai Properti

TelemetryOptions

Diwarisi DariInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opsi untuk mengonfigurasi autentikasi TLS

tlsOptions?: TlsSettings

Nilai Properti

TlsSettings

Diwarisi DariInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Opsi untuk menyediakan lapisan persistensi (jika tersedia) saat menyimpan kredensial.

Anda harus terlebih dahulu mendaftarkan plugin penyedia persistensi. Lihat paket di @azure/identity-cache-persistence NPM.

Contoh:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Nilai Properti

TokenCachePersistenceOptions

Diwarisi DariCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

userAgentOptions?: UserAgentPolicyOptions

Nilai Properti

UserAgentPolicyOptions

Diwarisi DariInteractiveCredentialOptions.userAgentOptions