GetDocumentOptions interface

Paquet:

@azure/search-documents

Options de récupération d’un document unique.

Extends

OperationOptions

Propriétés

selectedFields	Liste des noms de champs à récupérer pour le document ; Tout champ non récupéré est manquant dans le document retourné.
xMsEnableElevatedRead	Une valeur qui permet une lecture élevée contournant les vérifications de permissions au niveau du document pour l’opération de requête.
xMsQuerySourceAuthorization	Jeton identifiant l’utilisateur pour lequel la requête est exécutée. Ce jeton est utilisé pour appliquer des restrictions de sécurité sur les documents.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
serializerOptions	Options permettant de remplacer le comportement de sérialisation/de désérialisation.
tracingOptions	Options utilisées lorsque le suivi est activé.

Détails de la propriété

selectedFields

Liste des noms de champs à récupérer pour le document ; Tout champ non récupéré est manquant dans le document retourné.

selectedFields?: SelectArray<TFields>

Valeur de propriété

SelectArray<TFields>

xMsEnableElevatedRead

Une valeur qui permet une lecture élevée contournant les vérifications de permissions au niveau du document pour l’opération de requête.

xMsEnableElevatedRead?: boolean

Valeur de propriété

boolean

xMsQuerySourceAuthorization

Jeton identifiant l’utilisateur pour lequel la requête est exécutée. Ce jeton est utilisé pour appliquer des restrictions de sécurité sur les documents.

xMsQuerySourceAuthorization?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

Hérité de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

Hérité de OperationOptions.requestOptions

serializerOptions

Options permettant de remplacer le comportement de sérialisation/de désérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

héritée de OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de OperationOptions.tracingOptions