Compartilhar via

SearchClientOptions interface

  • Referência
Pacote:
@azure/search-documents

Opções de cliente usadas para configurar solicitações de API do Cognitive Search.

Extends
ExtendedCommonClientOptions

Propriedades

apiVersion

A versão da API a ser usada ao se comunicar com o serviço.
audience

O Público-alvo a ser usado para autenticação com o AAD (Azure Active Directory). O público-alvo não é considerado ao usar uma chave compartilhada. KnownSearchAudience pode ser usado intercambiável com público-alvo
serviceVersion

A versão do serviço a ser usada ao se comunicar com o serviço.

Propriedades herdadas

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.
allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
httpClient

O HttpClient que será usado para enviar solicitações HTTP.
keepAliveOptions

Opções para desabilitar manter-se vivo.
proxyOptions

Opções para configurar um proxy para solicitações de saída.
redirectOptions

Opções de como as respostas de redirecionamento são tratadas.
retryOptions

Opções que controlam como repetir solicitações com falha.
telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
tlsOptions

Opções para configurar a autenticação TLS
userAgentOptions

Opções para adicionar detalhes do agente de usuário a solicitações de saída.

Detalhes da propriedade

apiVersion

Aviso

Essa API foi preterida.

use serviceVersion instead

A versão da API a ser usada ao se comunicar com o serviço.

apiVersion?: string

Valor da propriedade

string

audience

O Público-alvo a ser usado para autenticação com o AAD (Azure Active Directory). O público-alvo não é considerado ao usar uma chave compartilhada. KnownSearchAudience pode ser usado intercambiável com público-alvo

audience?: string

Valor da propriedade

string

serviceVersion

A versão do serviço a ser usada ao se comunicar com o serviço.

serviceVersion?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor da propriedade

AdditionalPolicyConfig[]

Herdado de ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor da propriedade

boolean

Herdado de ExtendedCommonClientOptions.allowInsecureConnection

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor da propriedade

HttpClient

Herdado de ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opções para desabilitar manter-se vivo.

keepAliveOptions?: KeepAliveOptions

Valor da propriedade

KeepAliveOptions

Herdado de ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opções para configurar um proxy para solicitações de saída.

proxyOptions?: ProxySettings

Valor da propriedade

ProxySettings

Herdado de ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Valor da propriedade

RedirectPolicyOptions & RedirectOptions

Herdado de ExtendedCommonClientOptions.redirectOptions

retryOptions

Opções que controlam como repetir solicitações com falha.

retryOptions?: PipelineRetryOptions

Valor da propriedade

PipelineRetryOptions

Herdado de ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor da propriedade

TelemetryOptions

Herdado de ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação TLS

tlsOptions?: TlsSettings

Valor da propriedade

TlsSettings

Herdado de ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente de usuário a solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor da propriedade

UserAgentPolicyOptions

Herdado de ExtendedCommonClientOptions.userAgentOptions