Share via


DefaultAzureCredentialResourceIdOptions interface

提供設定 DefaultAzureCredential 類別的選項。 此變化支援 managedIdentityResourceId 和 不支援 managedIdentityClientId ,因為只支援這兩者之一。

Extends

屬性

managedIdentityResourceId

選擇性地傳入 ManagedIdentityCredential要使用的資源識別碼。 在使用 ARM 範本建立使用者指派的身分識別等案例中,已知身分識別的資源識別碼,但無法事先得知用戶端識別碼,此參數可讓程式使用這些使用者指派的身分識別,而不需要先判斷所建立身分識別的用戶端識別碼。

繼承的屬性

additionallyAllowedTenants

針對多租使用者應用程式,指定認證可能會取得權杖的其他租使用者。 新增萬用字元值 「*」,以允許認證取得已安裝應用程式之任何租使用者的權杖。

additionalPolicies

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

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>AzureDeveloperCliCredentialAzureCliCredential。 認證的進程逾時應以毫秒為單位提供。

proxyOptions

設定傳出要求 Proxy 的選項。

redirectOptions

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

retryOptions

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

telemetryOptions

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

tenantId

選擇性地傳入租使用者識別碼,以作為認證的一部分。 根據預設,它可能會根據基礎認證來使用一般租使用者識別碼。

tlsOptions

設定 TLS 驗證的選項

userAgentOptions

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

屬性詳細資料

managedIdentityResourceId

選擇性地傳入 ManagedIdentityCredential要使用的資源識別碼。 在使用 ARM 範本建立使用者指派的身分識別等案例中,已知身分識別的資源識別碼,但無法事先得知用戶端識別碼,此參數可讓程式使用這些使用者指派的身分識別,而不需要先判斷所建立身分識別的用戶端識別碼。

managedIdentityResourceId: string

屬性值

string

繼承的屬性詳細資料

additionallyAllowedTenants

針對多租使用者應用程式,指定認證可能會取得權杖的其他租使用者。 新增萬用字元值 「*」,以允許認證取得已安裝應用程式之任何租使用者的權杖。

additionallyAllowedTenants?: string[]

屬性值

string[]

繼承自DefaultAzureCredentialOptions.additionallyAllowedTenants

additionalPolicies

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

additionalPolicies?: AdditionalPolicyConfig[]

屬性值

繼承自DefaultAzureCredentialOptions.additionalPolicies

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

屬性值

繼承自DefaultAzureCredentialOptions.HTTPClient

loggingOptions

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

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

屬性值

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

繼承自DefaultAzureCredentialOptions.loggingOptions

processTimeoutInMs

可針對開發人員認證提出權杖要求的逾時,也就是 、 <xref:AzurePowershellCredential>AzureDeveloperCliCredentialAzureCliCredential。 認證的進程逾時應以毫秒為單位提供。

processTimeoutInMs?: number

屬性值

number

繼承自DefaultAzureCredentialOptions.processTimeoutInMs

proxyOptions

設定傳出要求 Proxy 的選項。

proxyOptions?: ProxySettings

屬性值

繼承自DefaultAzureCredentialOptions.proxyOptions

redirectOptions

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

redirectOptions?: RedirectPolicyOptions

屬性值

繼承自DefaultAzureCredentialOptions.redirectOptions

retryOptions

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

retryOptions?: PipelineRetryOptions

屬性值

繼承自DefaultAzureCredentialOptions.retryOptions

telemetryOptions

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

telemetryOptions?: TelemetryOptions

屬性值

繼承自DefaultAzureCredentialOptions.telemetryOptions

tenantId

選擇性地傳入租使用者識別碼,以作為認證的一部分。 根據預設,它可能會根據基礎認證來使用一般租使用者識別碼。

tenantId?: string

屬性值

string

繼承自DefaultAzureCredentialOptions.tenantId

tlsOptions

設定 TLS 驗證的選項

tlsOptions?: TlsSettings

屬性值

繼承自DefaultAzureCredentialOptions.tlsOptions

userAgentOptions

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

userAgentOptions?: UserAgentPolicyOptions

屬性值

繼承自DefaultAzureCredentialOptions.userAgentOptions