BlobDownloadOptionalParams | @azure/storage-blob

Optional parameters.

Hierarchy

any
- BlobDownloadOptionalParams

Index

Properties

Optional cpkInfo

cpkInfo: CpkInfo

Parameter group

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Parameter group

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Parameter group

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 timeoutInSeconds

timeoutInSeconds: undefined | number

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

Optional versionId

versionId: undefined | string

The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer.