BlobDownloadOptions interface

Package:

@azure/storage-blob

Options to configure the <xref:BlobClient.download> operation.

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.
conditions	Conditions to meet when downloading blobs.
customerProvidedKey	Customer Provided Key Info.
maxRetryRequests	Optional. ONLY AVAILABLE IN NODE.JS. How many retries will perform when original body 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 FileClient.download() request will be made from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached. Default value is 5, please set a larger value when loading large files in poor network.
onProgress	Call back to receive events on the progress of download operation.
rangeGetContentCrc64	When this is set to true and download range of blob, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size. rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
rangeGetContentMD5	When this is set to true and download range of blob, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
snapshot	An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.
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

conditions

Conditions to meet when downloading blobs.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

maxRetryRequests

Optional. ONLY AVAILABLE IN NODE.JS. How many retries will perform when original body 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 FileClient.download() request will be made from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached.

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

maxRetryRequests?: number

Property Value

number

onProgress

Call back to receive events on the progress of download operation.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

rangeGetContentCrc64

When this is set to true and download range of blob, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size. rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.

rangeGetContentCrc64?: boolean

Property Value

boolean

rangeGetContentMD5

When this is set to true and download range of blob, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.

rangeGetContentMD5?: boolean

Property Value

boolean

snapshot

An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.

snapshot?: string

Property Value

string

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions