BlockBlobParallelUploadOptions interface

  • Reference
Package:
@azure/storage-blob

Option interface for uploadFile and <xref:BlockBlobClient.uploadSeekableStream>.

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.
blobHTTPHeaders

Blob HTTP Headers. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.
blockSize

Destination block blob size in bytes.
concurrency

Concurrency of parallel uploading. Must be greater than or equal to 0.
conditions

Access conditions headers.
encryptionScope

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.
maxSingleShotSize

Blob size threshold in bytes to start concurrency uploading. Default value is 256MB, blob size less than this option will be uploaded via one I/O operation without concurrency. You can customize a value less equal than the default value.
metadata

Metadata of block blob.
onProgress

Progress updater.
tags

Blob tags.
tier

Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

Inherited Properties

tracingOptions

Options to configure spans created when tracing is enabled.

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

blobHTTPHeaders

Blob HTTP Headers. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

blobHTTPHeaders?: BlobHTTPHeaders

Property Value

BlobHTTPHeaders

blockSize

Destination block blob size in bytes.

blockSize?: number

Property Value

number

concurrency

Concurrency of parallel uploading. Must be greater than or equal to 0.

concurrency?: number

Property Value

number

conditions

Access conditions headers.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

encryptionScope

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

encryptionScope?: string

Property Value

string

maxSingleShotSize

Blob size threshold in bytes to start concurrency uploading. Default value is 256MB, blob size less than this option will be uploaded via one I/O operation without concurrency. You can customize a value less equal than the default value.

maxSingleShotSize?: number

Property Value

number

metadata

Metadata of block blob.

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

onProgress

Progress updater.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

tags

Blob tags.

tags?: Tags

Property Value

Tags

tier

Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

tier?: string

Property Value

string

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions