GetDocumentOptions interface

Paket:

@azure/search-documents

Alternativ för att hämta ett enskilt dokument.

Extends

OperationOptions

Egenskaper

selectedFields	Lista över fältnamn som ska hämtas för dokumentet. Alla fält som inte hämtas saknas i det returnerade dokumentet.
xMsEnableElevatedRead	Ett värde som möjliggör förhöjd läsning som kringgår behörighetskontroller på dokumentnivå för frågeåtgärden.
xMsQuerySourceAuthorization	Token som identifierar den användare som frågan körs för. Denna token används för att framtvinga säkerhetsbegränsningar för dokument.

Ärvda egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
onResponse	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
serializerOptions	Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
tracingOptions	Alternativ som används när spårning är aktiverat.

Egenskapsinformation

selectedFields

Lista över fältnamn som ska hämtas för dokumentet. Alla fält som inte hämtas saknas i det returnerade dokumentet.

selectedFields?: SelectArray<TFields>

Egenskapsvärde

SelectArray<TFields>

xMsEnableElevatedRead

Ett värde som möjliggör förhöjd läsning som kringgår behörighetskontroller på dokumentnivå för frågeåtgärden.

xMsEnableElevatedRead?: boolean

Egenskapsvärde

boolean

xMsQuerySourceAuthorization

Token som identifierar den användare som frågan körs för. Denna token används för att framtvinga säkerhetsbegränsningar för dokument.

xMsQuerySourceAuthorization?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

Ärvd från OperationOptions.abortSignal

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

Ärvd från OperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

Ärvd från OperationOptions.requestOptions

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

SerializerOptions

ärvd från OperationOptions.serializerOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

Ärvd från OperationOptions.tracingOptions