你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchClientOptions interface

包:

@azure/search-documents

用于配置认知搜索 API 请求的客户端选项。

Extends

ExtendedCommonClientOptions

属性

apiVersion	与服务通信时要使用的 API 版本。
audience	用于 Azure Active Directory 身份验证的受众 (AAD) 。 使用共享密钥时，不考虑受众。 KnownSearchAudience 可与受众互换使用
serviceVersion	与服务通信时要使用的服务版本。

继承属性

additionalPolicies	要包含在 HTTP 管道中的其他策略。
allowInsecureConnection	如果请求是通过 HTTP 而不是 HTTPS 发送的，则设置为 true
httpClient	将用于发送 HTTP 请求的 HttpClient。
keepAliveOptions	禁用保持活动状态的选项。
proxyOptions	用于为传出请求配置代理的选项。
redirectOptions	有关如何处理重定向响应的选项。
retryOptions	控制如何重试失败请求的选项。
telemetryOptions	用于将常见遥测和跟踪信息设置为传出请求的选项。
tlsOptions	用于配置 TLS 身份验证的选项
userAgentOptions	用于将用户代理详细信息添加到传出请求的选项。

属性详细信息

apiVersion

警告

现已弃用此 API。

use serviceVersion instead

与服务通信时要使用的 API 版本。

apiVersion?: string

属性值

string

audience

用于 Azure Active Directory 身份验证的受众 (AAD) 。 使用共享密钥时，不考虑受众。 KnownSearchAudience 可与受众互换使用

audience?: string

属性值

string

serviceVersion

与服务通信时要使用的服务版本。

serviceVersion?: string

属性值

string

继承属性详细信息

additionalPolicies

要包含在 HTTP 管道中的其他策略。

additionalPolicies?: AdditionalPolicyConfig[]

属性值

AdditionalPolicyConfig[]

继承自 ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

如果请求是通过 HTTP 而不是 HTTPS 发送的，则设置为 true

allowInsecureConnection?: boolean

属性值

boolean

继承自 ExtendedCommonClientOptions.allowInsecureConnection

httpClient

将用于发送 HTTP 请求的 HttpClient。

httpClient?: HttpClient

属性值

HttpClient

继承自 ExtendedCommonClientOptions.httpClient

keepAliveOptions

禁用保持活动状态的选项。

keepAliveOptions?: KeepAliveOptions

属性值

KeepAliveOptions

继承自 ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

用于为传出请求配置代理的选项。

proxyOptions?: ProxySettings

属性值

ProxySettings

继承自 ExtendedCommonClientOptions.proxyOptions

redirectOptions

有关如何处理重定向响应的选项。

redirectOptions?: RedirectPolicyOptions & RedirectOptions

属性值

RedirectPolicyOptions & RedirectOptions

继承自 ExtendedCommonClientOptions.redirectOptions

retryOptions

控制如何重试失败请求的选项。

retryOptions?: PipelineRetryOptions

属性值

PipelineRetryOptions

继承自 ExtendedCommonClientOptions.retryOptions

telemetryOptions

用于将常见遥测和跟踪信息设置为传出请求的选项。

telemetryOptions?: TelemetryOptions

属性值

TelemetryOptions

继承自 ExtendedCommonClientOptions.telemetryOptions

tlsOptions

用于配置 TLS 身份验证的选项

tlsOptions?: TlsSettings

属性值

TlsSettings

继承自 ExtendedCommonClientOptions.tlsOptions

userAgentOptions

用于将用户代理详细信息添加到传出请求的选项。

userAgentOptions?: UserAgentPolicyOptions

属性值

UserAgentPolicyOptions

继承自 ExtendedCommonClientOptions.userAgentOptions