SearchIndexerClientOptions interface
用來設定認知搜尋 API 要求的用戶端選項。
- Extends
屬性
api |
與服務通訊時要使用的 API 版本。 |
audience | 要用於 Azure Active Directory (AAD) 驗證的物件。 使用共用金鑰時,不會考慮物件。 KnownSearchAudience 可以與物件交換使用 |
service |
與服務通訊時要使用的服務版本。 |
繼承的屬性
additional |
要包含在 HTTP 管線中的其他原則。 |
allow |
如果要求是透過 HTTP 而非 HTTPS 傳送,則設定為 true |
http |
將用來傳送 HTTP 要求的 HttpClient。 |
keep |
停用保持運作的選項。 |
proxy |
設定傳出要求 Proxy 的選項。 |
redirect |
如何處理重新導向回應的選項。 |
retry |
控制如何重試失敗要求的選項。 |
telemetry |
將一般遙測和追蹤資訊設定為傳出要求的選項。 |
tls |
設定 TLS 驗證的選項 |
user |
將使用者代理程式詳細資料新增至傳出要求的選項。 |
屬性詳細資料
apiVersion
警告
此 API 現已淘汰。
use {@Link serviceVersion} instead
與服務通訊時要使用的 API 版本。
apiVersion?: string
屬性值
string
audience
要用於 Azure Active Directory (AAD) 驗證的物件。 使用共用金鑰時,不會考慮物件。 KnownSearchAudience 可以與物件交換使用
audience?: string
屬性值
string
serviceVersion
與服務通訊時要使用的服務版本。
serviceVersion?: string
屬性值
string
繼承的屬性詳細資料
additionalPolicies
要包含在 HTTP 管線中的其他原則。
additionalPolicies?: AdditionalPolicyConfig[]
屬性值
繼承自 ExtendedCommonClientOptions.additionalPolicies
allowInsecureConnection
如果要求是透過 HTTP 而非 HTTPS 傳送,則設定為 true
allowInsecureConnection?: boolean
屬性值
boolean
繼承自 ExtendedCommonClientOptions.allowInsecureConnection
httpClient
將用來傳送 HTTP 要求的 HttpClient。
httpClient?: HttpClient
屬性值
繼承自 ExtendedCommonClientOptions.HTTPClient
keepAliveOptions
停用保持運作的選項。
keepAliveOptions?: KeepAliveOptions
屬性值
繼承自 ExtendedCommonClientOptions.keepAliveOptions
proxyOptions
設定傳出要求 Proxy 的選項。
proxyOptions?: ProxySettings
屬性值
繼承自 ExtendedCommonClientOptions.proxyOptions
redirectOptions
如何處理重新導向回應的選項。
redirectOptions?: RedirectPolicyOptions & RedirectOptions
屬性值
繼承自 ExtendedCommonClientOptions.redirectOptions
retryOptions
控制如何重試失敗要求的選項。
retryOptions?: PipelineRetryOptions
屬性值
繼承自 ExtendedCommonClientOptions.retryOptions
telemetryOptions
將一般遙測和追蹤資訊設定為傳出要求的選項。
telemetryOptions?: TelemetryOptions
屬性值
繼承自 ExtendedCommonClientOptions.telemetryOptions
tlsOptions
userAgentOptions
將使用者代理程式詳細資料新增至傳出要求的選項。
userAgentOptions?: UserAgentPolicyOptions
屬性值
繼承自 ExtendedCommonClientOptions.userAgentOptions