次の方法で共有


GetDocumentOptions interface

1 つのドキュメントを取得するためのオプション。

Extends

プロパティ

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

プロパティ値

OperationOptions.abortSignal から継承された

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

OperationOptions.onResponse から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationOptions.requestOptions から継承された

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

OperationOptions.serializerOptions から継承された

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationOptions.tracingOptions から継承された