FileGetRangeListOptions interface

パッケージ:

@azure/storage-file-share

getRangeList 操作を構成するためのオプション。

Extends

CommonOptions

プロパティ

abortSignal	操作を AbortSignalLike 取り消す要求を通知する インターフェイスの実装。 たとえば、@azure/abort-controller を使用して を作成します AbortSignal。
includeRenames	このヘッダーは、prevShareSnapshot パラメーターが設定されている場合にのみ許可されます。 ターゲット スナップショット (またはライブ ファイル) と前のスナップショットの間で名前が変更または移動されたファイルの変更された範囲を一覧表示するかどうかを指定します。 値が true の場合、ファイルの有効な変更された範囲が返されます。 値が false の場合、操作は 409 (競合) 応答で失敗します。 既定値は false です。
leaseAccessConditions	リース アクセス条件。
range	省略可能。 範囲を一覧表示するバイトの範囲を指定します。

継承されたプロパティ

tracingOptions

プロパティの詳細

abortSignal

操作を AbortSignalLike 取り消す要求を通知する インターフェイスの実装。 たとえば、@azure/abort-controller を使用して を作成します AbortSignal。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

includeRenames

このヘッダーは、prevShareSnapshot パラメーターが設定されている場合にのみ許可されます。 ターゲット スナップショット (またはライブ ファイル) と前のスナップショットの間で名前が変更または移動されたファイルの変更された範囲を一覧表示するかどうかを指定します。 値が true の場合、ファイルの有効な変更された範囲が返されます。 値が false の場合、操作は 409 (競合) 応答で失敗します。 既定値は false です。

includeRenames?: boolean

プロパティ値

boolean

leaseAccessConditions

リース アクセス条件。

leaseAccessConditions?: LeaseAccessConditions

プロパティ値

LeaseAccessConditions

range

省略可能。 範囲を一覧表示するバイトの範囲を指定します。

range?: Range_2

プロパティ値

Range

継承されたプロパティの詳細

tracingOptions

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

CommonOptions.tracingOptionsから継承