SearchClientOptions interface

Pakket:

@azure/search-documents

Clientopties die worden gebruikt voor het configureren van Cognitive Search-API-aanvragen.

Extends

ExtendedCommonClientOptions

Eigenschappen

apiVersion	De API-versie die moet worden gebruikt bij de communicatie met de service.
audience	De doelgroep die moet worden gebruikt voor verificatie met Azure Active Directory (AAD). De doelgroep wordt niet meegenomen bij het gebruik van een gedeelde sleutel. KnownSearchAudience kan door elkaar worden gebruikt met een doelgroep
serviceVersion	De serviceversie die moet worden gebruikt bij de communicatie met de service.

Overgenomen eigenschappen

additionalPolicies	Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.
allowInsecureConnection	Ingesteld op true als de aanvraag wordt verzonden via HTTP in plaats van HTTPS
httpClient	De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.
keepAliveOptions	Opties om Keep Alive uit te schakelen.
proxyOptions	Opties voor het configureren van een proxy voor uitgaande aanvragen.
redirectOptions	Opties voor hoe omleidingsreacties worden verwerkt.
retryOptions	Opties voor het opnieuw proberen van mislukte aanvragen.
telemetryOptions	Opties voor het instellen van algemene telemetrie- en traceringsgegevens voor uitgaande aanvragen.
tlsOptions	Opties voor het configureren van TLS-verificatie
userAgentOptions	Opties voor het toevoegen van details van de gebruikersagent aan uitgaande aanvragen.

Eigenschapdetails

apiVersion

Waarschuwing

Deze API is nu afgeschaft.

use serviceVersion instead

De API-versie die moet worden gebruikt bij de communicatie met de service.

apiVersion?: string

Waarde van eigenschap

string

audience

De doelgroep die moet worden gebruikt voor verificatie met Azure Active Directory (AAD). De doelgroep wordt niet meegenomen bij het gebruik van een gedeelde sleutel. KnownSearchAudience kan door elkaar worden gebruikt met een doelgroep

audience?: string

Waarde van eigenschap

string

serviceVersion

De serviceversie die moet worden gebruikt bij de communicatie met de service.

serviceVersion?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

additionalPolicies

Aanvullende beleidsregels die moeten worden opgenomen in de HTTP-pijplijn.

additionalPolicies?: AdditionalPolicyConfig[]

Waarde van eigenschap

AdditionalPolicyConfig[]

Overgenomen van ExtendedCommonClientOptions.additionalPolicies

allowInsecureConnection

Ingesteld op true als de aanvraag wordt verzonden via HTTP in plaats van HTTPS

allowInsecureConnection?: boolean

Waarde van eigenschap

boolean

Overgenomen van ExtendedCommonClientOptions.allowInsecureConnection

httpClient

De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

Overgenomen van ExtendedCommonClientOptions.httpClient

keepAliveOptions

Opties om Keep Alive uit te schakelen.

keepAliveOptions?: KeepAliveOptions

Waarde van eigenschap

KeepAliveOptions

Overgenomen van ExtendedCommonClientOptions.keepAliveOptions

proxyOptions

Opties voor het configureren van een proxy voor uitgaande aanvragen.

proxyOptions?: ProxySettings

Waarde van eigenschap

ProxySettings

Overgenomen van ExtendedCommonClientOptions.proxyOptions

redirectOptions

Opties voor hoe omleidingsreacties worden verwerkt.

redirectOptions?: RedirectPolicyOptions & RedirectOptions

Waarde van eigenschap

RedirectPolicyOptions & RedirectOptions

Overgenomen van ExtendedCommonClientOptions.redirectOptions

retryOptions

Opties voor het opnieuw proberen van mislukte aanvragen.

retryOptions?: PipelineRetryOptions

Waarde van eigenschap

PipelineRetryOptions

Overgenomen van ExtendedCommonClientOptions.retryOptions

telemetryOptions

Opties voor het instellen van algemene telemetrie- en traceringsgegevens voor uitgaande aanvragen.

telemetryOptions?: TelemetryOptions

Waarde van eigenschap

TelemetryOptions

Overgenomen van ExtendedCommonClientOptions.telemetryOptions

tlsOptions

Opties voor het configureren van TLS-verificatie

tlsOptions?: TlsSettings

Waarde van eigenschap

TlsSettings

Overgenomen van ExtendedCommonClientOptions.tlsOptions

userAgentOptions

Opties voor het toevoegen van details van de gebruikersagent aan uitgaande aanvragen.

userAgentOptions?: UserAgentPolicyOptions

Waarde van eigenschap

UserAgentPolicyOptions

Overgenomen van ExtendedCommonClientOptions.userAgentOptions