Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BlobDownloadOptionalParams

Package version

Optional Parameters.

Hierarchy

Indexable

[key: string]: any

Optional Parameters.

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional cpkInfo

cpkInfo: CpkInfo

Additional parameters for the operation

Optional customHeaders

customHeaders: undefined | object
property

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Additional parameters for the operation

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Additional parameters for the operation

Optional onDownloadProgress

onDownloadProgress: undefined | function

Callback which fires upon download progress.

Optional onUploadProgress

onUploadProgress: undefined | function

Callback which fires upon upload progress.

Optional range

range: undefined | string

Return only the bytes of the blob in the specified range.

Optional rangeGetContentCRC64

rangeGetContentCRC64: undefined | false | true

When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size.

Optional rangeGetContentMD5

rangeGetContentMD5: undefined | false | true

When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional snapshot

snapshot: undefined | string

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.

Optional spanOptions

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

Optional timeout

timeout: undefined | number

The number of milliseconds a request can take before automatically being terminated.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Generated using TypeDoc