BlobRenameOptionalParams interface

Package:

@azure/storage-blob

Optional Parameters.

Extends

RequestOptionsBase

Properties

directoryHttpHeaders	Additional parameters for the operation
directoryProperties	Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded.
leaseAccessConditions	Additional parameters for the operation
modifiedAccessConditions	Additional parameters for the operation
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.
posixUmask	Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used.
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.
sourceLeaseId	A lease ID for the source path. If specified, the source path must have an active lease and the leaase ID must match.
sourceModifiedAccessConditions	Additional parameters for the operation
timeoutParameter	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

directoryHttpHeaders

Additional parameters for the operation

directoryHttpHeaders?: DirectoryHttpHeaders

Property Value

DirectoryHttpHeaders

directoryProperties

Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is base64 encoded.

directoryProperties?: string

Property Value

string

leaseAccessConditions

Additional parameters for the operation

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

modifiedAccessConditions

Additional parameters for the operation

modifiedAccessConditions?: ModifiedAccessConditions

Property Value

ModifiedAccessConditions

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?: string

Property Value

string

posixUmask

Only valid if Hierarchical Namespace is enabled for the account. This umask restricts permission settings for file and directory, and will only be applied when default Acl does not exist in parent directory. If the umask bit has set, it means that the corresponding permission will be disabled. Otherwise the corresponding permission will be determined by the permission. A 4-digit octal notation (e.g. 0022) is supported here. If no umask was specified, a default umask - 0027 will be used.

posixUmask?: string

Property Value

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?: string

Property Value

string

sourceLeaseId

A lease ID for the source path. If specified, the source path must have an active lease and the leaase ID must match.

sourceLeaseId?: string

Property Value

string

sourceModifiedAccessConditions

Additional parameters for the operation

sourceModifiedAccessConditions?: SourceModifiedAccessConditions

Property Value

SourceModifiedAccessConditions

timeoutParameter

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

timeoutParameter?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

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

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout