你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

BlobDownloadHeaders interface

包:

@azure/storage-blob

定义下载操作的标头。

属性

acceptRanges	指示服务支持针对部分 Blob 内容的请求。
blobCommittedBlockCount	Blob 中存在的已提交块数。 仅对追加 Blob 返回此标头。
blobContentMD5	如果 blob 具有 MD5 哈希，并且请求包含 range 标头 (Range 或 x-ms-range) ，则返回此响应标头以及整个 blob 的 MD5 值的值。 此值不一定等于 Content-MD5 标头中返回的值，后者是从请求的范围计算得出的
blobSequenceNumber	页 Blob 的当前序列号。 块 Blob 或追加 Blob 不返回此标头
blobType	Blob 的类型。 可能的值包括：“BlockBlob”、“PageBlob”、“AppendBlob”
cacheControl	如果为 Blob 指定了此标头，则返回此标头。
clientRequestId	如果在请求中发送客户端请求 ID 标头，则此标头将出现在具有相同值的响应中。
contentCrc64	如果请求要读取指定范围，并且 x-ms-range-get-content-crc64 设置为 true，则只要范围大小小于或等于 4 MB，请求将返回该范围的 crc64。 如果同一请求中同时指定了 x-ms-range-get-content-crc64 & x-ms-range-get-content-md5，则它将失败并显示 400 (错误的请求)
contentDisposition	此标头返回为“x-ms-blob-content-disposition”标头指定的值。 Content-Disposition 响应标头字段传达了有关如何处理响应有效负载的其他信息，还可用于附加其他元数据。 例如，如果设置为 attachment，则表示用户代理不应显示响应，而是显示文件名不是指定的 blob 名称的“另存为”对话框。
contentEncoding	此标头返回为 Content-Encoding 请求标头指定的值
contentLanguage	此标头返回为 Content-Language 请求标头指定的值。
contentLength	响应正文中存在的字节数。
contentMD5	如果 Blob 具有 MD5 哈希，并且此操作用于读取完整 Blob，则返回此响应标头，以便客户端可以检查消息内容完整性。
contentRange	指示客户端通过设置“Range”请求标头请求 Blob 子集时返回的字节范围。
contentType	响应正文的媒体类型。 对于下载 Blob，这是“application/octet-stream”
copyCompletionTime	上次尝试复制 Blob 操作的结束时间，其中此 Blob 是目标 Blob。 该值可以指定已完成、已中止或失败的复制尝试时间。 如果副本处于挂起状态，如果此 Blob 从未成为复制 Blob 操作中的目标，或者在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后修改了此 Blob，则不会显示此标头。
copyId	此复制操作的字符串标识符。 与“获取 Blob 属性”结合使用以检查此复制操作的状态，或传递到“中止复制 Blob”以中止挂起的副本。
copyProgress	包含上次尝试的复制 Blob 操作中复制的字节数和源中的总字节数，其中此 Blob 是目标 Blob。 可以显示介于 0 和复制的内容长度字节之间。 如果此 Blob 从未成为复制 Blob 操作中的目标，或者此 Blob 在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后进行了修改，则不会显示此标头
copySource	URL 长度最大为 2 KB，指定上次尝试的复制 Blob 操作中使用的源 Blob 或文件，其中此 Blob 是目标 Blob。 如果此 Blob 从未成为复制 Blob 操作中的目标，或者在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后修改了此 Blob，则不会显示此标头。
copyStatus	由 x-ms-copy-id 标识的复制操作的状态。可能的值包括：“pending”、“success”、“aborted”、“failed”
copyStatusDescription	仅当 x-ms-copy-status 失败或挂起时显示。 说明上次严重或不严重的复制操作故障的原因。 如果此 Blob 从未成为复制 Blob 操作中的目标，或者此 Blob 在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后进行了修改，则不会显示此标头
date	服务生成的 UTC 日期/时间值，指示响应的启动时间
encryptionKeySha256	用于加密 Blob 的加密密钥的 SHA-256 哈希。 仅当使用客户提供的密钥加密 Blob 时，才会返回此标头。
errorCode
eTag	ETag 包含一个值，你可以使用该值有条件地执行操作。 如果请求版本为 2011-08-18 和更高版本，ETag 值将用引号引起来。
isServerEncrypted	如果使用指定的算法完全加密 Blob 数据和应用程序元数据，则此标头的值设置为 true。 否则，当 blob 未加密或仅加密) blob/应用程序元数据的一部分时，该值将设置为 false (。
lastModified	返回上次修改容器的日期和时间。 任何修改 Blob 的操作（包括 Blob 元数据或属性更新）都会更改 Blob 的上次修改时间。
leaseDuration	在租用 Blob 时，指定租约是无限期还是固定时间。 可能的值包括：“infinite”、“fixed”
leaseState	Blob 的租约状态。 可能的值包括：“available”、“leased”、“expired”、“breaking”、“broken”
leaseStatus	Blob 的当前租约状态。 可能的值包括：“locked”、“unlocked”
metadata
requestId	此标头唯一地标识发出的请求，并且可用于解决请求问题。
version	指示用于执行请求的 BLOB 服务的版本。 针对 2009-09-19 和更高版本发出的请求将返回此标头。

属性详细信息

acceptRanges

指示服务支持针对部分 Blob 内容的请求。

acceptRanges?: string

属性值

string

blobCommittedBlockCount

Blob 中存在的已提交块数。 仅对追加 Blob 返回此标头。

blobCommittedBlockCount?: number

属性值

number

blobContentMD5

如果 blob 具有 MD5 哈希，并且请求包含 range 标头 (Range 或 x-ms-range) ，则返回此响应标头以及整个 blob 的 MD5 值的值。 此值不一定等于 Content-MD5 标头中返回的值，后者是从请求的范围计算得出的

blobContentMD5?: Uint8Array

属性值

Uint8Array

blobSequenceNumber

页 Blob 的当前序列号。 块 Blob 或追加 Blob 不返回此标头

blobSequenceNumber?: number

属性值

number

blobType

Blob 的类型。 可能的值包括：“BlockBlob”、“PageBlob”、“AppendBlob”

blobType?: BlobType

属性值

BlobType

cacheControl

如果为 Blob 指定了此标头，则返回此标头。

cacheControl?: string

属性值

string

clientRequestId

如果在请求中发送客户端请求 ID 标头，则此标头将出现在具有相同值的响应中。

clientRequestId?: string

属性值

string

contentCrc64

如果请求要读取指定范围，并且 x-ms-range-get-content-crc64 设置为 true，则只要范围大小小于或等于 4 MB，请求将返回该范围的 crc64。 如果同一请求中同时指定了 x-ms-range-get-content-crc64 & x-ms-range-get-content-md5，则它将失败并显示 400 (错误的请求)

contentCrc64?: Uint8Array

属性值

Uint8Array

contentDisposition

此标头返回为“x-ms-blob-content-disposition”标头指定的值。 Content-Disposition 响应标头字段传达了有关如何处理响应有效负载的其他信息，还可用于附加其他元数据。 例如，如果设置为 attachment，则表示用户代理不应显示响应，而是显示文件名不是指定的 blob 名称的“另存为”对话框。

contentDisposition?: string

属性值

string

contentEncoding

此标头返回为 Content-Encoding 请求标头指定的值

contentEncoding?: string

属性值

string

contentLanguage

此标头返回为 Content-Language 请求标头指定的值。

contentLanguage?: string

属性值

string

contentLength

响应正文中存在的字节数。

contentLength?: number

属性值

number

contentMD5

如果 Blob 具有 MD5 哈希，并且此操作用于读取完整 Blob，则返回此响应标头，以便客户端可以检查消息内容完整性。

contentMD5?: Uint8Array

属性值

Uint8Array

contentRange

指示客户端通过设置“Range”请求标头请求 Blob 子集时返回的字节范围。

contentRange?: string

属性值

string

contentType

响应正文的媒体类型。 对于下载 Blob，这是“application/octet-stream”

contentType?: string

属性值

string

copyCompletionTime

上次尝试复制 Blob 操作的结束时间，其中此 Blob 是目标 Blob。 该值可以指定已完成、已中止或失败的复制尝试时间。 如果副本处于挂起状态，如果此 Blob 从未成为复制 Blob 操作中的目标，或者在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后修改了此 Blob，则不会显示此标头。

copyCompletionTime?: Date

属性值

Date

copyId

此复制操作的字符串标识符。 与“获取 Blob 属性”结合使用以检查此复制操作的状态，或传递到“中止复制 Blob”以中止挂起的副本。

copyId?: string

属性值

string

copyProgress

包含上次尝试的复制 Blob 操作中复制的字节数和源中的总字节数，其中此 Blob 是目标 Blob。 可以显示介于 0 和复制的内容长度字节之间。 如果此 Blob 从未成为复制 Blob 操作中的目标，或者此 Blob 在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后进行了修改，则不会显示此标头

copyProgress?: string

属性值

string

copySource

URL 长度最大为 2 KB，指定上次尝试的复制 Blob 操作中使用的源 Blob 或文件，其中此 Blob 是目标 Blob。 如果此 Blob 从未成为复制 Blob 操作中的目标，或者在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后修改了此 Blob，则不会显示此标头。

copySource?: string

属性值

string

copyStatus

由 x-ms-copy-id 标识的复制操作的状态。可能的值包括：“pending”、“success”、“aborted”、“failed”

copyStatus?: CopyStatusType

属性值

CopyStatusType

copyStatusDescription

仅当 x-ms-copy-status 失败或挂起时显示。 说明上次严重或不严重的复制操作故障的原因。 如果此 Blob 从未成为复制 Blob 操作中的目标，或者此 Blob 在使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”完成复制 Blob 操作后进行了修改，则不会显示此标头

copyStatusDescription?: string

属性值

string

date

服务生成的 UTC 日期/时间值，指示响应的启动时间

date?: Date

属性值

Date

encryptionKeySha256

用于加密 Blob 的加密密钥的 SHA-256 哈希。 仅当使用客户提供的密钥加密 Blob 时，才会返回此标头。

encryptionKeySha256?: string

属性值

string

errorCode

errorCode?: string

属性值

string

eTag

ETag 包含一个值，你可以使用该值有条件地执行操作。 如果请求版本为 2011-08-18 和更高版本，ETag 值将用引号引起来。

eTag?: string

属性值

string

isServerEncrypted

如果使用指定的算法完全加密 Blob 数据和应用程序元数据，则此标头的值设置为 true。 否则，当 blob 未加密或仅加密) blob/应用程序元数据的一部分时，该值将设置为 false (。

isServerEncrypted?: boolean

属性值

boolean

lastModified

返回上次修改容器的日期和时间。 任何修改 Blob 的操作（包括 Blob 元数据或属性更新）都会更改 Blob 的上次修改时间。

lastModified?: Date

属性值

Date

leaseDuration

在租用 Blob 时，指定租约是无限期还是固定时间。 可能的值包括：“infinite”、“fixed”

leaseDuration?: LeaseDurationType

属性值

LeaseDurationType

leaseState

Blob 的租约状态。 可能的值包括：“available”、“leased”、“expired”、“breaking”、“broken”

leaseState?: LeaseStateType

属性值

LeaseStateType

leaseStatus

Blob 的当前租约状态。 可能的值包括：“locked”、“unlocked”

leaseStatus?: LeaseStatusType

属性值

LeaseStatusType

metadata

metadata?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

requestId

此标头唯一地标识发出的请求，并且可用于解决请求问题。

requestId?: string

属性值

string

version

指示用于执行请求的 BLOB 服务的版本。 针对 2009-09-19 和更高版本发出的请求将返回此标头。

version?: string

属性值

string