SearchClientOptions interface

Csomag:

@azure/search-documents

A Cognitive Search API-kérések konfigurálásához használt ügyfélbeállítások.

Extends

ExtendedCommonClientOptions

Tulajdonságok

apiVersion	A szolgáltatással való kommunikációhoz használandó API-verzió.
audience	Az Azure Active Directoryval (AAD) való hitelesítéshez használni kívánt célközönség. A célközönség nem számít megosztott kulcs használatakor. A KnownSearchAudience felcserélhető a közönséggel
serviceVersion	A szolgáltatással való kommunikációhoz használandó szolgáltatásverzió.

Örökölt tulajdonságok

additionalPolicies	A HTTP-folyamatba belefoglalandó további szabályzatok.
allowInsecureConnection	Igaz értékre van állítva, ha a kérés HTTPS helyett HTTP-en keresztül van elküldve
httpClient	A HTTP-kérések küldéséhez használt HttpClient.
keepAliveOptions	Az életben tartás letiltásának lehetőségei.
proxyOptions	A kimenő kérelmek proxyjának konfigurálásának beállításai.
redirectOptions	Az átirányítási válaszok kezelésének beállításai.
retryOptions	A sikertelen kérések újrapróbálkozására vonatkozó beállítások.
telemetryOptions	A gyakori telemetriai adatok beállításának és a kimenő kérések nyomon követésének beállításai.
tlsOptions	A TLS-hitelesítés konfigurálásának lehetőségei
userAgentOptions	A felhasználói ügynök adatainak a kimenő kérelmekhez való hozzáadásának lehetőségei.

Tulajdonság adatai

apiVersion

Figyelmeztetés

Ez az API már elavult.

use serviceVersion instead

A szolgáltatással való kommunikációhoz használandó API-verzió.

apiVersion?: string

Tulajdonság értéke

string

audience

Az Azure Active Directoryval (AAD) való hitelesítéshez használni kívánt célközönség. A célközönség nem számít megosztott kulcs használatakor. A KnownSearchAudience felcserélhető a közönséggel

audience?: string

Tulajdonság értéke

string

serviceVersion

A szolgáltatással való kommunikációhoz használandó szolgáltatásverzió.

serviceVersion?: string

Tulajdonság értéke

string

Örökölt tulajdonság részletei

additionalPolicies

A HTTP-folyamatba belefoglalandó további szabályzatok.

additionalPolicies?: AdditionalPolicyConfig[]

Tulajdonság értéke

AdditionalPolicyConfig[]

Örökölt forrás ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Igaz értékre van állítva, ha a kérés HTTPS helyett HTTP-en keresztül van elküldve

allowInsecureConnection?: boolean

Tulajdonság értéke

boolean

Örökölt forrás ExtendedCommonClientOptions.allowInsecureConnection

httpClient

A HTTP-kérések küldéséhez használt HttpClient.

httpClient?: HttpClient

Tulajdonság értéke

HttpClient

Örökölt forrás ExtendedCommonClientOptions.httpClient

keepAliveOptions

Az életben tartás letiltásának lehetőségei.

keepAliveOptions?: KeepAliveOptions

Tulajdonság értéke

KeepAliveOptions

Örökölt forrás ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

A kimenő kérelmek proxyjának konfigurálásának beállításai.

proxyOptions?: ProxySettings

Tulajdonság értéke

ProxySettings

Örökölt forrás ExtendedCommonClientOptions.proxyOptions

redirectOptions

Az átirányítási válaszok kezelésének beállításai.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Tulajdonság értéke

RedirectPolicyOptions & RedirectOptions

Örökölt forrás ExtendedCommonClientOptions.redirectOptions

retryOptions

A sikertelen kérések újrapróbálkozására vonatkozó beállítások.

retryOptions?: PipelineRetryOptions

Tulajdonság értéke

PipelineRetryOptions

Örökölt forrás ExtendedCommonClientOptions.retryOptions

telemetryOptions

A gyakori telemetriai adatok beállításának és a kimenő kérések nyomon követésének beállításai.

telemetryOptions?: TelemetryOptions

Tulajdonság értéke

TelemetryOptions

Örökölt forrás ExtendedCommonClientOptions.telemetryOptions

tlsOptions

A TLS-hitelesítés konfigurálásának lehetőségei

tlsOptions?: TlsSettings

Tulajdonság értéke

TlsSettings

Örökölt forrás ExtendedCommonClientOptions.tlsOptions

userAgentOptions

A felhasználói ügynök adatainak a kimenő kérelmekhez való hozzáadásának lehetőségei.

userAgentOptions?: UserAgentPolicyOptions

Tulajdonság értéke

UserAgentPolicyOptions

Örökölt forrás ExtendedCommonClientOptions.userAgentOptions