Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BlobDownloadOptions

Package version

Options to configure the BlobClient.download operation.

export
interface

BlobDownloadOptions

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

memberof

BlobDownloadOptions

Optional conditions

Conditions to meet when downloading blobs.

memberof

BlobDownloadOptions

Optional customerProvidedKey

customerProvidedKey: CpkInfo

Customer Provided Key Info.

memberof

BlobDownloadOptions

Optional maxRetryRequests

maxRetryRequests: undefined | number

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.

memberof

BlobDownloadOptions

Optional onProgress

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

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

memberof

BlobDownloadOptions

Optional rangeGetContentCrc64

rangeGetContentCrc64: undefined | false | true

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.

memberof

BlobDownloadOptions

Optional rangeGetContentMD5

rangeGetContentMD5: undefined | false | true

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.

memberof

BlobDownloadOptions

Optional snapshot

snapshot: undefined | string

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

memberof

BlobDownloadOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc