SearchClientOptions interface

Paquete:

@azure/search-documents

Opciones de cliente usadas para configurar solicitudes de Cognitive Search API.

Extends

ExtendedCommonClientOptions

Propiedades

apiVersion	La versión de LA API que se va a usar al comunicarse con el servicio.
audience	Audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se considera cuando se usa una clave compartida. KnownSearchAudience se puede usar indistintamente con la audiencia.
serviceVersion	La versión del servicio que se va a usar al comunicarse con el servicio.

Propiedades heredadas

additionalPolicies	Directivas adicionales que se van a incluir en la canalización HTTP.
allowInsecureConnection	Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.
httpClient	HttpClient que se usará para enviar solicitudes HTTP.
keepAliveOptions	Opciones para deshabilitar keep alive.
proxyOptions	Opciones para configurar un proxy para las solicitudes salientes.
redirectOptions	Opciones para controlar las respuestas de redireccionamiento.
retryOptions	Opciones que controlan cómo reintentar las solicitudes con error.
telemetryOptions	Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.
tlsOptions	Opciones para configurar la autenticación TLS
userAgentOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Detalles de las propiedades

apiVersion

Advertencia

Esta API ya está en desuso.

use serviceVersion instead

La versión de LA API que se va a usar al comunicarse con el servicio.

apiVersion?: string

Valor de propiedad

string

audience

Audiencia que se va a usar para la autenticación con Azure Active Directory (AAD). La audiencia no se considera cuando se usa una clave compartida. KnownSearchAudience se puede usar indistintamente con la audiencia.

audience?: string

Valor de propiedad

string

serviceVersion

La versión del servicio que se va a usar al comunicarse con el servicio.

serviceVersion?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

additionalPolicies

Directivas adicionales que se van a incluir en la canalización HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de propiedad

AdditionalPolicyConfig[]

Heredado de ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Se establece en true si la solicitud se envía a través de HTTP en lugar de HTTPS.

allowInsecureConnection?: boolean

Valor de propiedad

boolean

Heredado de ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

Heredado de ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opciones para deshabilitar keep alive.

keepAliveOptions?: KeepAliveOptions

Valor de propiedad

KeepAliveOptions

Heredado de ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opciones para configurar un proxy para las solicitudes salientes.

proxyOptions?: ProxySettings

Valor de propiedad

ProxySettings

Heredado de ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opciones para controlar las respuestas de redireccionamiento.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Valor de propiedad

RedirectPolicyOptions & RedirectOptions

Heredado de ExtendedCommonClientOptions.redirectOptions

retryOptions

Opciones que controlan cómo reintentar las solicitudes con error.

retryOptions?: PipelineRetryOptions

Valor de propiedad

PipelineRetryOptions

Heredado de ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opciones para establecer información de seguimiento y telemetría comunes en las solicitudes salientes.

telemetryOptions?: TelemetryOptions

Valor de propiedad

TelemetryOptions

Heredado de ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opciones para configurar la autenticación TLS

tlsOptions?: TlsSettings

Valor de propiedad

TlsSettings

Heredado de ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

userAgentOptions?: UserAgentPolicyOptions

Valor de propiedad

UserAgentPolicyOptions

Heredado de ExtendedCommonClientOptions.userAgentOptions