DefaultAzureCredentialClientIdOptions interface

套件:

@azure/identity

提供選項來設定 DefaultAzureCredential 類別。 這個變化支援 managedIdentityClientId，而不是 managedIdentityResourceId，因為只支援其中一個。

Extends

DefaultAzureCredentialOptions

屬性

managedIdentityClientId	選擇性地傳入使用者指派的用戶端標識符，供 ManagedIdentityCredential使用。 此用戶端識別碼也可以透過環境變數傳遞至 ManagedIdentityCredential：AZURE_CLIENT_ID。
workloadIdentityClientId	選擇性地傳入使用者指派的用戶端標識符，供 WorkloadIdentityCredential使用。 此用戶端識別碼也可以透過環境變數傳遞至 WorkloadIdentityCredential：AZURE_CLIENT_ID。

繼承的屬性

additionallyAllowedTenants	針對多租使用者應用程式，指定認證可取得令牌的其他租使用者。 新增通配符值 「*」 以允許認證取得安裝應用程式之任何租使用者的令牌。
additionalPolicies	要包含在 HTTP 管線中的其他原則。
agent	針對傳出要求設定 Agent 實例的選項
allowInsecureConnection	如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true
authorityHost	要用於驗證要求的授權單位主機。 可能的值可透過 AzureAuthorityHosts取得。 預設值為 「https://login.microsoftonline.com"。
disableInstanceDiscovery	欄位會決定在嘗試驗證時是否執行實例探索。 將此設定為 true 會完全停用實例探索和授權單位驗證。 因此，請務必確保已設定的授權單位主機有效且值得信任。 這項功能適用於無法連線到元數據端點的案例，例如在私人雲端或 Azure Stack 中。 實例探索的程式需要從 https://login.microsoft.com/ 擷取授權單位元數據，以驗證授權單位。
httpClient	將用來傳送 HTTP 要求的 HttpClient。
loggingOptions	允許使用者設定記錄原則選項的設定、允許記錄帳戶資訊和客戶支援的個人標識資訊。
processTimeoutInMs	針對開發人員認證進行令牌要求的逾時，即 <xref:AzurePowershellCredential>、AzureDeveloperCliCredential，以及 AzureCliCredential。 認證的進程逾時應該以毫秒為單位提供。
proxyOptions	設定連出要求 Proxy 的選項。
redirectOptions	如何處理重新導向響應的選項。
requiredEnvVars	必須在執行階段定義的環境變數清單。 如果此清單中的任何變數遺失或設定為空值， DefaultAzureCredential 建構函式會擲回錯誤。 使用此選項可強制您的應用程式在繼續執行之前具有必要的環境設定。
retryOptions	控制如何重試失敗要求的選項。
telemetryOptions	將一般遙測和追蹤資訊設定為傳出要求的選項。
tenantId	選擇性地傳入要當做認證一部分使用的租用戶標識碼。 根據預設，它可能會根據基礎認證使用一般租使用者標識符。
tlsOptions	設定 TLS 驗證的選項
userAgentOptions	將使用者代理程式詳細數據新增至傳出要求的選項。

屬性詳細資料

managedIdentityClientId

選擇性地傳入使用者指派的用戶端標識符，供 ManagedIdentityCredential使用。 此用戶端識別碼也可以透過環境變數傳遞至 ManagedIdentityCredential：AZURE_CLIENT_ID。

managedIdentityClientId?: string

屬性值

string

workloadIdentityClientId

選擇性地傳入使用者指派的用戶端標識符，供 WorkloadIdentityCredential使用。 此用戶端識別碼也可以透過環境變數傳遞至 WorkloadIdentityCredential：AZURE_CLIENT_ID。

workloadIdentityClientId?: string

屬性值

string

繼承的屬性詳細資料

additionallyAllowedTenants

針對多租使用者應用程式，指定認證可取得令牌的其他租使用者。 新增通配符值 「*」 以允許認證取得安裝應用程式之任何租使用者的令牌。

additionallyAllowedTenants?: string[]

屬性值

string[]

繼承自DefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

要包含在 HTTP 管線中的其他原則。

additionalPolicies?: AdditionalPolicyConfig[]

屬性值

AdditionalPolicyConfig[]

繼承自DefaultAzureCredentialOptions.additionalPolicies

agent

針對傳出要求設定 Agent 實例的選項

agent?: Agent

屬性值

Agent

繼承自DefaultAzureCredentialOptions.agent

allowInsecureConnection

如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true

allowInsecureConnection?: boolean

屬性值

boolean

繼承自DefaultAzureCredentialOptions.allowInsecureConnection

authorityHost

要用於驗證要求的授權單位主機。 可能的值可透過 AzureAuthorityHosts取得。 預設值為 「https://login.microsoftonline.com"。

authorityHost?: string

屬性值

string

繼承自DefaultAzureCredentialOptions.authorityHost

disableInstanceDiscovery

欄位會決定在嘗試驗證時是否執行實例探索。 將此設定為 true 會完全停用實例探索和授權單位驗證。 因此，請務必確保已設定的授權單位主機有效且值得信任。 這項功能適用於無法連線到元數據端點的案例，例如在私人雲端或 Azure Stack 中。 實例探索的程式需要從 https://login.microsoft.com/ 擷取授權單位元數據，以驗證授權單位。

disableInstanceDiscovery?: boolean

屬性值

boolean

繼承自DefaultAzureCredentialOptions.disableInstanceDiscovery

httpClient

將用來傳送 HTTP 要求的 HttpClient。

httpClient?: HttpClient

屬性值

HttpClient

繼承自DefaultAzureCredentialOptions.httpClient

loggingOptions

允許使用者設定記錄原則選項的設定、允許記錄帳戶資訊和客戶支援的個人標識資訊。

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

屬性值

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

繼承自DefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

針對開發人員認證進行令牌要求的逾時，即 <xref:AzurePowershellCredential>、AzureDeveloperCliCredential，以及 AzureCliCredential。 認證的進程逾時應該以毫秒為單位提供。

processTimeoutInMs?: number

屬性值

number

繼承自DefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

設定連出要求 Proxy 的選項。

proxyOptions?: ProxySettings

屬性值

ProxySettings

繼承自DefaultAzureCredentialOptions.proxyOptions

redirectOptions

如何處理重新導向響應的選項。

redirectOptions?: RedirectPolicyOptions

屬性值

RedirectPolicyOptions

繼承自DefaultAzureCredentialOptions.redirectOptions

requiredEnvVars

必須在執行階段定義的環境變數清單。 如果此清單中的任何變數遺失或設定為空值， DefaultAzureCredential 建構函式會擲回錯誤。 使用此選項可強制您的應用程式在繼續執行之前具有必要的環境設定。

requiredEnvVars?: DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

屬性值

DefaultAzureCredentialEnvVars | DefaultAzureCredentialEnvVars[]

繼承自DefaultAzureCredentialOptions.requiredEnvVars

retryOptions

控制如何重試失敗要求的選項。

retryOptions?: PipelineRetryOptions

屬性值

PipelineRetryOptions

繼承自DefaultAzureCredentialOptions.retryOptions

telemetryOptions

將一般遙測和追蹤資訊設定為傳出要求的選項。

telemetryOptions?: TelemetryOptions

屬性值

TelemetryOptions

繼承自DefaultAzureCredentialOptions.telemetryOptions

tenantId

選擇性地傳入要當做認證一部分使用的租用戶標識碼。 根據預設，它可能會根據基礎認證使用一般租使用者標識符。

tenantId?: string

屬性值

string

繼承自DefaultAzureCredentialOptions.tenantId

tlsOptions

設定 TLS 驗證的選項

tlsOptions?: TlsSettings

屬性值

TlsSettings

繼承自DefaultAzureCredentialOptions.tlsOptions

userAgentOptions

將使用者代理程式詳細數據新增至傳出要求的選項。

userAgentOptions?: UserAgentPolicyOptions

屬性值

UserAgentPolicyOptions

繼承自DefaultAzureCredentialOptions.userAgentOptions