Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathChangeAccessControlRecursiveOptions

Package version

Options type for setAccessControlRecursive, updateAccessControlRecursive and removeAccessControlRecursive.

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

Optional batchSize

batchSize: undefined | number

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.

Optional continuationToken

continuationToken: undefined | string

Continuation token to continue next batch of operations.

Optional continueOnFailure

continueOnFailure: undefined | false | true

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.

Optional maxBatches

maxBatches: undefined | number

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.

Optional onProgress

onProgress: undefined | ((progress: AccessControlChanges) => void)

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

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc