GetDocumentOptions interface

套件:

@azure/search-documents

擷取單一文件的選項。

Extends

OperationOptions

屬性

selectedFields	要為檔擷取的域名清單;未擷取的任何字段都會從傳回的檔中遺失。
xMsEnableElevatedRead	啟用提高許可權讀取的值，可略過查詢作業的文件層級許可權檢查。
xMsQuerySourceAuthorization	識別正在執行查詢的使用者的權杖。 此權杖可用來對文件強制執行安全性限制。

繼承的屬性

abortSignal	可用來中止要求的訊號。
onResponse	每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。
requestOptions	建立和傳送此作業之 HTTP 要求時所使用的選項。
serializerOptions	覆寫串行化/取消串行化行為的選項。
tracingOptions	啟用追蹤時所使用的選項。

屬性詳細資料

selectedFields

要為檔擷取的域名清單;未擷取的任何字段都會從傳回的檔中遺失。

selectedFields?: SelectArray<TFields>

屬性值

SelectArray<TFields>

xMsEnableElevatedRead

啟用提高許可權讀取的值，可略過查詢作業的文件層級許可權檢查。

xMsEnableElevatedRead?: boolean

屬性值

boolean

xMsQuerySourceAuthorization

識別正在執行查詢的使用者的權杖。 此權杖可用來對文件強制執行安全性限制。

xMsQuerySourceAuthorization?: string

屬性值

string

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

繼承自 OperationOptions.abortSignal

onResponse

每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

RawResponseCallback

繼承自 OperationOptions.onResponse

requestOptions

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

OperationRequestOptions

繼承自 OperationOptions.requestOptions

serializerOptions

覆寫串行化/取消串行化行為的選項。

serializerOptions?: SerializerOptions

屬性值

SerializerOptions

繼承自 OperationOptions.serializerOptions

tracingOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自 OperationOptions.tracingOptions