Share via

PathChangeAccessControlRecursiveOptions interface

Package:
@azure/storage-file-datalake

Options type for setAccessControlRecursive, updateAccessControlRecursive and removeAccessControlRecursive.

Extends
CommonOptions

Properties

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
batchSize

Optional. If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. Batch size should be between 1 and 2000. The default when unspecified is 2000.
continuationToken

Continuation token to continue next batch of operations.
continueOnFailure

Optional. Default false. If set to false, the operation will terminate quickly on encountering user failures. If true, the operation will ignore user failures and proceed with the operation on other sub-entities of the directory.
maxBatches

Optional. Defines maximum number of batches that single change Access Control operation can execute. If maximum is reached before all subpaths are processed then continuation token can be used to resume operation. Empty value indicates that maximum number of batches in unbound and operation continues till end.
onProgress

Callback where caller can track progress of the operation as well as collect paths that failed to change Access Control.

Inherited Properties

tracingOptions

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

batchSize

Optional. If data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. Batch size should be between 1 and 2000. The default when unspecified is 2000.

batchSize?: number

Property Value

number

continuationToken

Continuation token to continue next batch of operations.

continuationToken?: string

Property Value

string

continueOnFailure

Optional. Default false. If set to false, the operation will terminate quickly on encountering user failures. If true, the operation will ignore user failures and proceed with the operation on other sub-entities of the directory.

continueOnFailure?: boolean

Property Value

boolean

maxBatches

Optional. Defines maximum number of batches that single change Access Control operation can execute. If maximum is reached before all subpaths are processed then continuation token can be used to resume operation. Empty value indicates that maximum number of batches in unbound and operation continues till end.

maxBatches?: number

Property Value

number

onProgress

Callback where caller can track progress of the operation as well as collect paths that failed to change Access Control.

onProgress?: (progress: AccessControlChanges) => void

Property Value

(progress: AccessControlChanges) => void

Inherited Property Details

tracingOptions 

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions