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

BlobDownloadHeaders interface

包:

@azure/storage-blob

定义Blob_download作的标头。

属性

acceptRanges	指示服务支持对部分 Blob 内容的请求。
blobCommittedBlockCount	Blob 中存在的已提交的块数。 仅针对追加 Blob 返回此标头。
blobContentMD5	如果 Blob 具有 MD5 哈希，并且如果请求包含范围标头（Range 或 x-ms-range），则返回此响应标头，其值为整个 blob 的 MD5 值。 此值可能等于 Content-MD5 标头中返回的值，后者是从请求的范围计算得出的
blobSequenceNumber	页 Blob 的当前序列号。 块 blob 或追加 Blob 不返回此标头
blobType	Blob 的类型。
cacheControl	如果以前为 Blob 指定了此标头，则返回此标头。
clientRequestId	如果在请求中发送客户端请求 ID 标头，此标头将出现在响应中，其值相同。
contentCrc64	如果请求读取指定范围并且 x-ms-range-get-content-crc64 设置为 true，则只要范围大小小于或等于 4 MB，请求将返回 crc64。 如果在同一请求中同时指定了 x-ms-range-get-content-md5 & x-ms-range-get-content-md5，则失败并出现 400（错误请求）。
contentDisposition	此标头返回为“x-ms-blob-content-disposition”标头指定的值。 Content-Disposition 响应标头字段传达有关如何处理响应有效负载的其他信息，还可用于附加其他元数据。 例如，如果设置为附件，则表示用户代理不应显示响应，而是显示文件名以外的文件名的“另存为”对话框。
contentEncoding	此标头返回为 Content-Encoding 请求标头指定的值
contentLanguage	此标头返回为 Content-Language 请求标头指定的值。
contentLength	响应正文中存在的字节数。
contentMD5	如果 Blob 具有 MD5 哈希，并且此作是读取完整 Blob，则返回此响应标头，以便客户端可以检查消息内容完整性。
contentRange	指示客户端通过设置“Range”请求标头请求 blob 子集时返回的字节范围。
contentType	响应正文的媒体类型。 对于下载 Blob，这是“application/octet-stream”
copyCompletedOn	上次尝试复制 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 标识的复制作的状态。
copyStatusDescription	仅当 x-ms-copy-status 失败或挂起时才显示。 描述最后一次致命或非致命复制作失败的原因。 如果此 Blob 从未在复制 Blob作中成为目标，或者此 Blob 在结束的复制 Blob作后使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”进行修改，则不会显示此标头
createdOn	返回创建 Blob 的日期和时间。
date	服务生成的 UTC 日期/时间值，指示响应启动的时间
encryptionKeySha256	用于加密 Blob 的加密密钥的 SHA-256 哈希。 仅当 Blob 使用客户提供的密钥加密时，才会返回此标头。
encryptionScope	返回用于加密 Blob 内容和应用程序元数据的加密范围的名称。 请注意，缺少此标头意味着使用默认帐户加密范围。
errorCode	错误代码
etag	ETag 包含可用于有条件地执行作的值。 如果请求版本为 2011-08-18 或更高版本，ETag 值将采用引号。
immutabilityPolicyExpiresOn	服务生成的 UTC 日期/时间值，指示 Blob 不可变性策略过期的时间。
immutabilityPolicyMode	指示不可变策略模式。
isCurrentVersion	此标头的值指示此 Blob 的版本是否为当前版本，另请参阅 x-ms-version-id 标头。
isSealed	如果此 Blob 已密封
isServerEncrypted	如果 blob 数据和应用程序元数据使用指定的算法完全加密，则此标头的值设置为 true。 否则，该值设置为 false（如果 blob 未加密，或者仅加密 blob/应用程序元数据的一部分）。
lastAccessed	服务生成的 UTC 日期/时间值，该值指示 Blob 上次读取或写入到的时间
lastModified	返回上次修改容器的日期和时间。 任何修改 Blob 的作（包括更新 blob 的元数据或属性）都更改 Blob 的上次修改时间。
leaseDuration	当 Blob 租用时，指定租约是无限持续时间还是固定持续时间。
leaseState	Blob 的租用状态。
leaseStatus	Blob 的当前租约状态。
legalHold	指示 Blob 上是否存在法定保留。
metadata
objectReplicationPolicyId	自选。 仅在为存储容器和复制的目标 Blob 启用对象复制时有效。
objectReplicationRules	自选。 仅在为存储容器和复制的源 Blob 启用对象复制时有效。 检索此标头时，它将返回具有策略 ID 和规则 ID（例如 x-ms-or-policyid_ruleid）的标头，该值将是复制的状态（例如完成，失败）。
requestId	此标头唯一标识已发出的请求，并可用于对请求进行故障排除。
tagCount	与 Blob 关联的标记数
version	指示用于执行请求的 Blob 服务的版本。 对于针对版本 2009-09-19 及更高版本发出的请求，将返回此标头。
versionId	由唯一标识 Blob 的服务返回的 DateTime 值。 此标头的值指示 Blob 版本，并可用于后续请求来访问此版本的 Blob。

属性详细信息

acceptRanges

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

acceptRanges?: string

属性值

string

blobCommittedBlockCount

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

blobCommittedBlockCount?: number

属性值

number

blobContentMD5

如果 Blob 具有 MD5 哈希，并且如果请求包含范围标头（Range 或 x-ms-range），则返回此响应标头，其值为整个 blob 的 MD5 值。 此值可能等于 Content-MD5 标头中返回的值，后者是从请求的范围计算得出的

blobContentMD5?: Uint8Array

属性值

Uint8Array

blobSequenceNumber

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

blobSequenceNumber?: number

属性值

number

blobType

Blob 的类型。

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-md5 & x-ms-range-get-content-md5，则失败并出现 400（错误请求）。

contentCrc64?: Uint8Array

属性值

Uint8Array

contentDisposition

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

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

copyCompletedOn

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

copyCompletedOn?: 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 标识的复制作的状态。

copyStatus?: CopyStatusType

属性值

CopyStatusType

copyStatusDescription

仅当 x-ms-copy-status 失败或挂起时才显示。 描述最后一次致命或非致命复制作失败的原因。 如果此 Blob 从未在复制 Blob作中成为目标，或者此 Blob 在结束的复制 Blob作后使用“设置 Blob 属性”、“放置 Blob”或“放置块列表”进行修改，则不会显示此标头

copyStatusDescription?: string

属性值

string

createdOn

返回创建 Blob 的日期和时间。

createdOn?: Date

属性值

Date

date

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

date?: Date

属性值

Date

encryptionKeySha256

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

encryptionKeySha256?: string

属性值

string

encryptionScope

返回用于加密 Blob 内容和应用程序元数据的加密范围的名称。 请注意，缺少此标头意味着使用默认帐户加密范围。

encryptionScope?: string

属性值

string

errorCode

错误代码

errorCode?: string

属性值

string

etag

ETag 包含可用于有条件地执行作的值。 如果请求版本为 2011-08-18 或更高版本，ETag 值将采用引号。

etag?: string

属性值

string

immutabilityPolicyExpiresOn

服务生成的 UTC 日期/时间值，指示 Blob 不可变性策略过期的时间。

immutabilityPolicyExpiresOn?: Date

属性值

Date

immutabilityPolicyMode

指示不可变策略模式。

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

属性值

BlobImmutabilityPolicyMode

isCurrentVersion

此标头的值指示此 Blob 的版本是否为当前版本，另请参阅 x-ms-version-id 标头。

isCurrentVersion?: boolean

属性值

boolean

isSealed

如果此 Blob 已密封

isSealed?: boolean

属性值

boolean

isServerEncrypted

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

isServerEncrypted?: boolean

属性值

boolean

lastAccessed

服务生成的 UTC 日期/时间值，该值指示 Blob 上次读取或写入到的时间

lastAccessed?: Date

属性值

Date

lastModified

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

lastModified?: Date

属性值

Date

leaseDuration

当 Blob 租用时，指定租约是无限持续时间还是固定持续时间。

leaseDuration?: LeaseDurationType

属性值

LeaseDurationType

leaseState

Blob 的租用状态。

leaseState?: LeaseStateType

属性值

LeaseStateType

leaseStatus

Blob 的当前租约状态。

leaseStatus?: LeaseStatusType

属性值

LeaseStatusType

legalHold

指示 Blob 上是否存在法定保留。

legalHold?: boolean

属性值

boolean

metadata

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

属性值

{[propertyName: string]: string}

objectReplicationPolicyId

自选。 仅在为存储容器和复制的目标 Blob 启用对象复制时有效。

objectReplicationPolicyId?: string

属性值

string

objectReplicationRules

自选。 仅在为存储容器和复制的源 Blob 启用对象复制时有效。 检索此标头时，它将返回具有策略 ID 和规则 ID（例如 x-ms-or-policyid_ruleid）的标头，该值将是复制的状态（例如完成，失败）。

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

属性值

{[propertyName: string]: string}

requestId

此标头唯一标识已发出的请求，并可用于对请求进行故障排除。

requestId?: string

属性值

string

tagCount

与 Blob 关联的标记数

tagCount?: number

属性值

number

version

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

version?: string

属性值

string

versionId

由唯一标识 Blob 的服务返回的 DateTime 值。 此标头的值指示 Blob 版本，并可用于后续请求来访问此版本的 Blob。

versionId?: string

属性值

string