Package version:

Interface BlobDownloadOptions

Options to configure the BlobClient.download operation.

interface BlobDownloadOptions {
    abortSignal?: any;
    conditions?: BlobRequestConditions;
    customerProvidedKey?: CpkInfo;
    maxRetryRequests?: number;
    onProgress?: ((progress: TransferProgressEvent) => void);
    rangeGetContentCrc64?: boolean;
    rangeGetContentMD5?: boolean;
    snapshot?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? conditions? customerProvidedKey? maxRetryRequests? onProgress? rangeGetContentCrc64? rangeGetContentMD5? snapshot? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

Optionalconditions

conditions?: BlobRequestConditions

Conditions to meet when downloading blobs.

OptionalcustomerProvidedKey

customerProvidedKey?: CpkInfo

Customer Provided Key Info.

OptionalmaxRetryRequests

maxRetryRequests?: 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.

OptionalonProgress

onProgress?: ((progress: TransferProgressEvent) => void)

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

OptionalrangeGetContentCrc64

rangeGetContentCrc64?: boolean

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.

OptionalrangeGetContentMD5

rangeGetContentMD5?: boolean

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.

Optionalsnapshot

snapshot?: string

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

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility