BlockBlobCommitBlockListOptionalParams interface

Package:

@azure/storage-blob

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
blobHTTPHeaders	Additional parameters for the operation
cpkInfo	Additional parameters for the operation
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
leaseAccessConditions	Additional parameters for the operation
metadata	Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.
modifiedAccessConditions	Additional parameters for the operation
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
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.
tier	Optional. Indicates the tier to be set on the blob. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'
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.
transactionalContentCrc64	Specify the transactional crc64 for the body, to be validated by the service.
transactionalContentMD5	Specify the transactional md5 for the body, to be validated by the service.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

blobHTTPHeaders

Additional parameters for the operation

blobHTTPHeaders?: BlobHTTPHeaders

Property Value

BlobHTTPHeaders

cpkInfo

Additional parameters for the operation

cpkInfo?: CpkInfo

Property Value

CpkInfo

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

leaseAccessConditions

Additional parameters for the operation

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

metadata

Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.

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

Property Value

undefined | [key: string]: string

modifiedAccessConditions

Additional parameters for the operation

modifiedAccessConditions?: ModifiedAccessConditions

Property Value

ModifiedAccessConditions

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

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

tier

Optional. Indicates the tier to be set on the blob. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'

tier?: AccessTier

Property Value

AccessTier

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

transactionalContentCrc64

Specify the transactional crc64 for the body, to be validated by the service.

transactionalContentCrc64?: Uint8Array

Property Value

Uint8Array

transactionalContentMD5

Specify the transactional md5 for the body, to be validated by the service.

transactionalContentMD5?: Uint8Array

Property Value

Uint8Array