IDownloadFromBlobOptions interface

Package:

@azure/storage-blob

Option interface for DownloadBlockBlobToBuffer.

Properties

blobAccessConditions	Access conditions headers.
blockSize	blockSize is the data every request trying to download. Must be >= 0, if set to 0 or undefined, blockSize will automatically calculated according to the blob size.
maxRetryRequestsPerBlock	Optional. ONLY AVAILABLE IN NODE.JS. How many retries will perform when original block download stream unexpected ends. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors. With this option, every additional retry means an additional FileURL.download() request will be made from the broken point, until the requested block has been successfully downloaded or maxRetryRequestsPerBlock is reached. Default value is 5, please set a larger value when in poor network.
parallelism	Concurrency of parallel download.
progress	Progress updater.

Property Details

blobAccessConditions

Access conditions headers.

blobAccessConditions?: IBlobAccessConditions

Property Value

IBlobAccessConditions

blockSize

blockSize is the data every request trying to download. Must be >= 0, if set to 0 or undefined, blockSize will automatically calculated according to the blob size.

blockSize?: undefined | number

Property Value

undefined | number

maxRetryRequestsPerBlock

Optional. ONLY AVAILABLE IN NODE.JS. How many retries will perform when original block download stream unexpected ends. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors.

With this option, every additional retry means an additional FileURL.download() request will be made from the broken point, until the requested block has been successfully downloaded or maxRetryRequestsPerBlock is reached.

Default value is 5, please set a larger value when in poor network.

maxRetryRequestsPerBlock?: undefined | number

Property Value

undefined | number

parallelism

Concurrency of parallel download.

parallelism?: undefined | number

Property Value

undefined | number

progress

Progress updater.

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

Property Value

undefined | (progress: TransferProgressEvent) => void