SearchIndexerClientOptions interface

Пакет:

@azure/search-documents

Параметры клиента, используемые для настройки запросов API Когнитивного поиска.

Extends

ExtendedCommonClientOptions

Свойства

apiVersion	Версия API, используемая при взаимодействии со службой.
audience	Аудитория, используемая для проверки подлинности с помощью Azure Active Directory (AAD). Аудитория не учитывается при использовании общего ключа. KnownSearchAudience можно использовать взаимозаменяемо с аудиторией
serviceVersion	Версия службы, используемая при взаимодействии со службой.

Унаследованные свойства

additionalPolicies	Дополнительные политики для включения в конвейер HTTP.
agent	Параметры настройки экземпляра агента для исходящих запросов
allowInsecureConnection	Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS
httpClient	HttpClient, который будет использоваться для отправки HTTP-запросов.
keepAliveOptions	Параметры отключения активности.
proxyOptions	Параметры настройки прокси-сервера для исходящих запросов.
redirectOptions	Параметры обработки ответов перенаправления.
retryOptions	Параметры, управляющие повторными неудачными запросами.
telemetryOptions	Параметры настройки общих данных телеметрии и трассировки для исходящих запросов.
tlsOptions	Параметры настройки проверки подлинности TLS
userAgentOptions	Параметры добавления сведений об агенте пользователя в исходящие запросы.

Сведения о свойстве

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[]

Значение свойства

AdditionalPolicyConfig[]

наследуется от ExtendedCommonClientOptions.additionalPolicies

agent

Параметры настройки экземпляра агента для исходящих запросов

agent?: Agent

Значение свойства

Agent

унаследован от ExtendedCommonClientOptions.agent

allowInsecureConnection

Задайте значение true, если запрос отправляется по протоколу HTTP вместо HTTPS

allowInsecureConnection?: boolean

Значение свойства

boolean

наследуется от ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HttpClient, который будет использоваться для отправки HTTP-запросов.

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