PathChangeAccessControlRecursiveOptions interface

パッケージ:

@azure/storage-file-datalake

setAccessControlRecursive、updateAccessControlRecursive、および removeAccessControlRecursiveのオプションの種類。

Extends

CommonOptions

プロパティ

abortSignal	操作を取り消す要求を通知する AbortSignalLike インターフェイスの実装。 たとえば、@azure/abort-controller を使用して AbortSignalを作成します。
batchSize	随意。 データ セットのサイズがバッチ サイズを超える場合、操作は複数の要求に分割され、進行状況を追跡できます。 バッチ サイズは 1 から 2000 の間にする必要があります。 指定されていない場合の既定値は 2000 です。
continuationToken	操作の次のバッチを続行するための継続トークン。
continueOnFailure	随意。 既定値は false です。 false に設定すると、ユーザーのエラーが発生すると、操作がすぐに終了します。 true の場合、操作はユーザーエラーを無視し、ディレクトリの他のサブエンティティに対する操作を続行します。
maxBatches	随意。 1 回の変更アクセス制御操作で実行できるバッチの最大数を定義します。 すべてのサブパスが処理される前に最大値に達した場合は、継続トークンを使用して操作を再開できます。 空の値は、無制限で操作の最大バッチ数が最後まで継続することを示します。
onProgress	呼び出し元が操作の進行状況を追跡し、アクセス制御の変更に失敗したパスを収集できるコールバック。

継承されたプロパティ

tracingOptions

プロパティの詳細

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

batchSize

随意。 データ セットのサイズがバッチ サイズを超える場合、操作は複数の要求に分割され、進行状況を追跡できます。 バッチ サイズは 1 から 2000 の間にする必要があります。 指定されていない場合の既定値は 2000 です。

batchSize?: number

プロパティ値

number

continuationToken

操作の次のバッチを続行するための継続トークン。

continuationToken?: string

プロパティ値

string

continueOnFailure

随意。 既定値は false です。 false に設定すると、ユーザーのエラーが発生すると、操作がすぐに終了します。 true の場合、操作はユーザーエラーを無視し、ディレクトリの他のサブエンティティに対する操作を続行します。

continueOnFailure?: boolean

プロパティ値

boolean

maxBatches

随意。 1 回の変更アクセス制御操作で実行できるバッチの最大数を定義します。 すべてのサブパスが処理される前に最大値に達した場合は、継続トークンを使用して操作を再開できます。 空の値は、無制限で操作の最大バッチ数が最後まで継続することを示します。

maxBatches?: number

プロパティ値

number

onProgress

呼び出し元が操作の進行状況を追跡し、アクセス制御の変更に失敗したパスを収集できるコールバック。

onProgress?: (progress: AccessControlChanges) => void

プロパティ値

(progress: AccessControlChanges) => void

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

tracingOptions

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元CommonOptions.tracingOptions