DefaultAzureCredentialClientIdOptions interface

Paket:

@azure/identity

Menyediakan opsi untuk mengonfigurasi kelas DefaultAzureCredential. Variasi ini mendukung managedIdentityClientId dan tidak managedIdentityResourceId, karena hanya salah satu dari keduanya yang didukung.

Memperluas

DefaultAzureCredentialOptions

Properti

managedIdentityClientId	Secara opsional meneruskan ID klien yang ditetapkan pengguna untuk digunakan oleh ManagedIdentityCredential . ID klien ini juga dapat diteruskan ke ManagedIdentityCredential melalui variabel lingkungan: AZURE_CLIENT_ID.
workloadIdentityClientId	Secara opsional meneruskan ID klien yang ditetapkan pengguna untuk digunakan oleh WorkloadIdentityCredential. ID klien ini juga dapat diteruskan ke WorkloadIdentityCredential melalui variabel lingkungan: AZURE_CLIENT_ID.

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 apa pun yang diinstal aplikasi.
additionalPolicies	Kebijakan tambahan untuk disertakan dalam alur HTTP.
agent	Opsi untuk mengonfigurasi instans Agen untuk permintaan keluar
allowInsecureConnection	Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS
authorityHost	Host otoritas yang digunakan untuk permintaan autentikasi. Nilai yang mungkin tersedia melalui AzureAuthorityHosts. Defaultnya adalah "https://login.microsoftonline.com".
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 untuk mengonfigurasi pengaturan untuk opsi kebijakan pengelogan, memungkinkan informasi akun pengelogan dan informasi identitas pribadi untuk dukungan pelanggan.
processTimeoutInMs	Batas waktu yang dapat dikonfigurasi untuk membuat permintaan token untuk kredensial pengembang, yaitu, <xref:AzurePowershellCredential>, azureDeveloperCliCredential dan AzureCliCredential. Batas waktu proses untuk kredensial harus disediakan dalam milidetik.
proxyOptions	Opsi untuk mengonfigurasi proksi untuk permintaan keluar.
redirectOptions	Opsi untuk bagaimana respons pengalihan ditangani.
requiredEnvVars	Daftar variabel lingkungan yang harus ditentukan saat runtime. Jika ada variabel dalam daftar ini yang hilang atau diatur ke nilai kosong, konstruktor DefaultAzureCredential akan memunculkan kesalahan. Gunakan ini untuk menegakkan bahwa aplikasi Anda memiliki konfigurasi lingkungan yang diperlukan sebelum melanjutkan eksekusi.
retryOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
telemetryOptions	Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.
tenantId	Secara opsional meneruskan ID Penyewa yang akan digunakan sebagai bagian dari kredensial. Secara default dapat menggunakan ID penyewa generik tergantung pada kredensial yang mendasar.
tlsOptions	Opsi untuk mengonfigurasi autentikasi TLS
userAgentOptions	Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

Detail Properti

managedIdentityClientId

Secara opsional meneruskan ID klien yang ditetapkan pengguna untuk digunakan oleh ManagedIdentityCredential . ID klien ini juga dapat diteruskan ke ManagedIdentityCredential melalui variabel lingkungan: AZURE_CLIENT_ID.

managedIdentityClientId?: string

Nilai Properti

string

workloadIdentityClientId

Secara opsional meneruskan ID klien yang ditetapkan pengguna untuk digunakan oleh WorkloadIdentityCredential. ID klien ini juga dapat diteruskan ke WorkloadIdentityCredential melalui variabel lingkungan: AZURE_CLIENT_ID.

workloadIdentityClientId?: string

Nilai Properti

string

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 apa pun yang diinstal aplikasi.

additionallyAllowedTenants?: string[]

Nilai Properti

string[]

Diwarisi DariDefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

Kebijakan tambahan untuk disertakan dalam alur HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Nilai Properti

AdditionalPolicyConfig[]

Diwariskan DariDefaultAzureCredentialOptions.additionalPolicies

agent

Opsi untuk mengonfigurasi instans Agen untuk permintaan keluar

agent?: Agent

Nilai Properti

Agent

Diwarisi DariDefaultAzureCredentialOptions.agent

allowInsecureConnection

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

allowInsecureConnection?: boolean

Nilai Properti

boolean

Diwarisi DariDefaultAzureCredentialOptions.allowInsecureConnection

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

Diwariskan DariDefaultAzureCredentialOptions.authorityHost

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

httpClient

HttpClient yang akan digunakan untuk mengirim permintaan HTTP.

httpClient?: HttpClient

Nilai Properti

HttpClient

Diwarisi DariDefaultAzureCredentialOptions.httpClient

loggingOptions

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

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

Nilai Properti

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

Diwariskan DariDefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

Batas waktu yang dapat dikonfigurasi untuk membuat permintaan token untuk kredensial pengembang, yaitu, <xref:AzurePowershellCredential>, azureDeveloperCliCredential dan AzureCliCredential. Batas waktu proses untuk kredensial harus disediakan dalam milidetik.

processTimeoutInMs?: number

Nilai Properti

number

Diwarisi DariDefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

Opsi untuk mengonfigurasi proksi untuk permintaan keluar.

proxyOptions?: ProxySettings

Nilai Properti

ProxySettings

Diwariskan DariDefaultAzureCredentialOptions.proxyOptions

redirectOptions

Opsi untuk bagaimana respons pengalihan ditangani.

redirectOptions?: RedirectPolicyOptions

Nilai Properti

RedirectPolicyOptions

Diwariskan DariDefaultAzureCredentialOptions.redirectOptions

requiredEnvVars

Daftar variabel lingkungan yang harus ditentukan saat runtime. Jika ada variabel dalam daftar ini yang hilang atau diatur ke nilai kosong, konstruktor DefaultAzureCredential akan memunculkan kesalahan. Gunakan ini untuk menegakkan bahwa aplikasi Anda memiliki konfigurasi lingkungan yang diperlukan sebelum melanjutkan eksekusi.

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

Nilai Properti

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

Diwarisi daridefaultAzureCredentialOptions.requiredEnvVars

retryOptions

Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.

retryOptions?: PipelineRetryOptions

Nilai Properti

PipelineRetryOptions

Diwarisi DariDefaultAzureCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

Nilai Properti

TelemetryOptions

Diwarisi DariDefaultAzureCredentialOptions.telemetryOptions

tenantId

Secara opsional meneruskan ID Penyewa yang akan digunakan sebagai bagian dari kredensial. Secara default dapat menggunakan ID penyewa generik tergantung pada kredensial yang mendasar.

tenantId?: string

Nilai Properti

string

Diwariskan DariDefaultAzureCredentialOptions.tenantId

tlsOptions

Opsi untuk mengonfigurasi autentikasi TLS

tlsOptions?: TlsSettings

Nilai Properti

TlsSettings

Diwariskan DariDefaultAzureCredentialOptions.tlsOptions

userAgentOptions

Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

userAgentOptions?: UserAgentPolicyOptions

Nilai Properti

UserAgentPolicyOptions

Diwarisi DariDefaultAzureCredentialOptions.userAgentOptions