Share via

SearchIndexClientOptions interface

Package:
@azure/search-documents

Client options used to configure Cognitive Search API requests.

Extends
ExtendedCommonClientOptions

Properties

apiVersion

The API version to use when communicating with the service.
audience

The Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key. KnownSearchAudience can be used interchangeably with audience
serviceVersion

The service version to use when communicating with the service.

Inherited Properties

additionalPolicies

Additional policies to include in the HTTP pipeline.
agent

Options for configuring Agent instance for outgoing requests
allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS
httpClient

The HttpClient that will be used to send HTTP requests.
keepAliveOptions

Options to disable keep alive.
proxyOptions

Options to configure a proxy for outgoing requests.
redirectOptions

Options for how redirect responses are handled.
retryOptions

Options that control how to retry failed requests.
telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions

Options for configuring TLS authentication
userAgentOptions

Options for adding user agent details to outgoing requests.

Property Details

apiVersion

Warning

This API is now deprecated.

use {@Link serviceVersion} instead

The API version to use when communicating with the service.

apiVersion?: string

Property Value

string

audience

The Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key. KnownSearchAudience can be used interchangeably with audience

audience?: string

Property Value

string

serviceVersion

The service version to use when communicating with the service.

serviceVersion?: string

Property Value

string

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From ExtendedCommonClientOptions.additionalPolicies

agent

Options for configuring Agent instance for outgoing requests

agent?: Agent

Property Value

Agent

Inherited From ExtendedCommonClientOptions.agent

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From ExtendedCommonClientOptions.allowInsecureConnection

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From ExtendedCommonClientOptions.httpClient

keepAliveOptions

Options to disable keep alive.

keepAliveOptions?: KeepAliveOptions

Property Value

KeepAliveOptions

Inherited From ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From ExtendedCommonClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Property Value

RedirectPolicyOptions & RedirectOptions

Inherited From ExtendedCommonClientOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From ExtendedCommonClientOptions.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From ExtendedCommonClientOptions.userAgentOptions