Package version:

Interface BlobDownloadOptionalParams

Optional parameters.

interface BlobDownloadOptionalParams {
    cpkInfo?: CpkInfo;
    leaseAccessConditions?: LeaseAccessConditions;
    modifiedAccessConditions?: ModifiedAccessConditionsModel;
    range?: string;
    rangeGetContentCRC64?: boolean;
    rangeGetContentMD5?: boolean;
    requestId?: string;
    snapshot?: string;
    timeoutInSeconds?: number;
    versionId?: string;
}

Hierarchy (view full)

Properties

cpkInfo? leaseAccessConditions? modifiedAccessConditions? range? rangeGetContentCRC64? rangeGetContentMD5? requestId? snapshot? timeoutInSeconds? versionId?

Properties

OptionalcpkInfo

cpkInfo?: CpkInfo

Parameter group

OptionalleaseAccessConditions

leaseAccessConditions?: LeaseAccessConditions

Parameter group

OptionalmodifiedAccessConditions

modifiedAccessConditions?: ModifiedAccessConditionsModel

Parameter group

Optionalrange

range?: string

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

OptionalrangeGetContentCRC64

rangeGetContentCRC64?: boolean

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.

OptionalrangeGetContentMD5

rangeGetContentMD5?: boolean

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.

OptionalrequestId

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

Optionalsnapshot

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

OptionaltimeoutInSeconds

timeoutInSeconds?: number

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

OptionalversionId

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

Settings

Member Visibility