다음을 통해 공유

SearchClientOptions interface

  • 참조
패키지:
@azure/search-documents

Cognitive Search API 요청을 구성하는 데 사용되는 클라이언트 옵션입니다.

Extends
ExtendedCommonClientOptions

속성

apiVersion

서비스와 통신할 때 사용할 API 버전입니다.
audience

AAD(Azure Active Directory)로 인증하는 데 사용할 대상 그룹입니다. 공유 키를 사용할 때 대상 그룹은 고려되지 않습니다. KnownSearchAudience 는 대상 그룹과 서로 교환하여 사용할 수 있습니다.
serviceVersion

서비스와 통신할 때 사용할 서비스 버전입니다.

상속된 속성

additionalPolicies

HTTP 파이프라인에 포함할 추가 정책입니다.
allowInsecureConnection

요청이 HTTPS 대신 HTTP를 통해 전송되는 경우 true로 설정
httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.
keepAliveOptions

활성 상태로 유지를 사용하지 않도록 설정하는 옵션입니다.
proxyOptions

나가는 요청에 대한 프록시를 구성하는 옵션입니다.
redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.
retryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.
telemetryOptions

일반적인 원격 분석 및 추적 정보를 나가는 요청으로 설정하는 옵션입니다.
tlsOptions

TLS 인증을 구성하기 위한 옵션
userAgentOptions

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

속성 세부 정보

apiVersion

경고

이 API는 이제 사용되지 않습니다.

use serviceVersion instead

서비스와 통신할 때 사용할 API 버전입니다.

apiVersion?: string

속성 값

string

audience

AAD(Azure Active Directory)로 인증하는 데 사용할 대상 그룹입니다. 공유 키를 사용할 때 대상 그룹은 고려되지 않습니다. KnownSearchAudience 는 대상 그룹과 서로 교환하여 사용할 수 있습니다.

audience?: string

속성 값

string

serviceVersion

서비스와 통신할 때 사용할 서비스 버전입니다.

serviceVersion?: string

속성 값

string

상속된 속성 세부 정보

additionalPolicies

HTTP 파이프라인에 포함할 추가 정책입니다.

additionalPolicies?: AdditionalPolicyConfig[]

속성 값

AdditionalPolicyConfig[]

상속된 From ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

요청이 HTTPS 대신 HTTP를 통해 전송되는 경우 true로 설정

allowInsecureConnection?: boolean

속성 값

boolean

상속된 From ExtendedCommonClientOptions.allowInsecureConnection

httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.

httpClient?: HttpClient

속성 값

HttpClient

상속된 From ExtendedCommonClientOptions.httpClient

keepAliveOptions

활성 상태로 유지를 사용하지 않도록 설정하는 옵션입니다.

keepAliveOptions?: KeepAliveOptions

속성 값

KeepAliveOptions

상속된 From ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

나가는 요청에 대한 프록시를 구성하는 옵션입니다.

proxyOptions?: ProxySettings

속성 값

ProxySettings

상속된 From ExtendedCommonClientOptions.proxyOptions

redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

속성 값

RedirectPolicyOptions & RedirectOptions

상속된 From ExtendedCommonClientOptions.redirectOptions

retryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

retryOptions?: PipelineRetryOptions

속성 값

PipelineRetryOptions

상속된 From ExtendedCommonClientOptions.retryOptions

telemetryOptions

일반적인 원격 분석 및 추적 정보를 나가는 요청으로 설정하는 옵션입니다.

telemetryOptions?: TelemetryOptions

속성 값

TelemetryOptions

상속된 From ExtendedCommonClientOptions.telemetryOptions

tlsOptions

TLS 인증을 구성하기 위한 옵션

tlsOptions?: TlsSettings

속성 값

TlsSettings

상속된 From ExtendedCommonClientOptions.tlsOptions

userAgentOptions

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

userAgentOptions?: UserAgentPolicyOptions

속성 값

UserAgentPolicyOptions

상속된 From ExtendedCommonClientOptions.userAgentOptions