BlobDownloadOptionalParams interface

Package:

@azure/storage-blob

Optional parameters.

Extends

OperationOptions

Properties

abortSignal	The signal which can be used to abort requests.
cpkInfo	Parameter group
leaseAccessConditions	Parameter group
modifiedAccessConditions	Parameter group
range	Return only the bytes of the blob in the specified range.
rangeGetContentCRC64	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.
rangeGetContentMD5	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.
requestId	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.
requestOptions	Options used when creating and sending HTTP requests for this operation.
snapshot	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.
timeoutInSeconds	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
tracingOptions	Options used when tracing is enabled.
versionId	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.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

cpkInfo

Parameter group

cpkInfo?: CpkInfo

Property Value

CpkInfo

leaseAccessConditions

Parameter group

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

modifiedAccessConditions

Parameter group

modifiedAccessConditions?: ModifiedAccessConditionsModel

Property Value

ModifiedAccessConditionsModel

range

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

range?: string

Property Value

string

rangeGetContentCRC64

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.

rangeGetContentCRC64?: boolean

Property Value

boolean

rangeGetContentMD5

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.

rangeGetContentMD5?: boolean

Property Value

boolean

requestId

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.

requestId?: string

Property Value

string

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

snapshot

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.

snapshot?: string

Property Value

string

timeoutInSeconds

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

timeoutInSeconds?: number

Property Value

number

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

versionId

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.

versionId?: string

Property Value

string