Share via


DirectorySetAccessControlOptionalParams interface

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal

The signal which can be used to abort requests.

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

group

Optional. The owning group of the blob or directory.

leaseAccessConditions

Additional parameters for the operation

modifiedAccessConditions

Additional parameters for the operation

onDownloadProgress

Callback which fires upon download progress.

onUploadProgress

Callback which fires upon upload progress.

owner

Optional. The owner of the blob or directory.

posixAcl

Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]".

posixPermissions

Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.

requestId

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

timeout

The number of milliseconds a request can take before automatically being terminated.

timeoutParameter

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

group

Optional. The owning group of the blob or directory.

group?: undefined | string

Property Value

undefined | string

leaseAccessConditions

Additional parameters for the operation

leaseAccessConditions?: LeaseAccessConditions

Property Value

modifiedAccessConditions

Additional parameters for the operation

modifiedAccessConditions?: ModifiedAccessConditions

Property Value

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

owner

Optional. The owner of the blob or directory.

owner?: undefined | string

Property Value

undefined | string

posixAcl

Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]".

posixAcl?: undefined | string

Property Value

undefined | string

posixPermissions

Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.

posixPermissions?: undefined | string

Property Value

undefined | string

requestId

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

requestId?: undefined | string

Property Value

undefined | string

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: undefined | number

Property Value

undefined | number

timeoutParameter

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

timeoutParameter?: undefined | number

Property Value

undefined | number