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

FileDownloadHeaders interface

包:: @azure/storage-file-share

定义File_download作的标头。

属性

acceptRanges	指示服务支持对部分文件内容的请求。
cacheControl	如果以前为文件指定了它，则返回。
contentDisposition	返回为“x-ms-content-disposition”标头指定的值，并指定如何处理响应。
contentEncoding	返回为 Content-Encoding 请求标头指定的值。
contentLanguage	返回为 Content-Language 请求标头指定的值。
contentLength	响应正文中存在的字节数。
contentMD5	如果文件具有 MD5 哈希，并且请求是读取完整文件，则返回此响应标头，以便客户端可以检查消息内容完整性。如果请求读取指定的范围，并且“x-ms-range-get-content-md5”设置为 true，则只要范围大小小于或等于 4 MB，请求将返回该范围的 MD5 哈希。如果这两组条件都不为 true，则不会为“Content-MD5”标头返回任何值。
contentRange	指示客户端通过设置 Range 请求标头请求文件的子集时返回的字节范围。
contentType	为文件指定的内容类型。默认内容类型为“application/octet-stream”
copyCompletedOn	上次尝试复制文件作的结束时间，该文件是目标文件。此值可以指定已完成、中止或失败复制尝试的时间。
copyId	上次尝试的复制文件作的字符串标识符，其中此文件是目标文件。
copyProgress	包含上次尝试的复制文件作中复制的字节数和源中的总字节数，其中此文件是目标文件。可以显示复制的 0 到内容长度字节。
copySource	URL 最大长度为 2KB，指定在上次尝试的复制文件作中使用的源文件，其中此文件是目标文件。
copyStatus	由“x-ms-copy-id”标识的复制作的状态。
copyStatusDescription	仅当 x-ms-copy-status 失败或挂起时才显示。描述致命或非致命复制作失败的原因。
date	由服务生成的 UTC 日期/时间值，指示响应的启动时间。
errorCode	错误代码
etag	ETag 包含一个值，可用于在引号中有条件地执行作。
fileAttributes	为文件设置的属性。
fileChangeOn	更改文件的时间。
fileContentMD5	如果文件具有 MD5 哈希，并且如果请求包含范围标头（Range 或 x-ms-range），则返回此响应标头，其值为整个文件的 MD5 值。此值可能等于 Content-MD5 标头中返回的值，后者是从请求的范围计算得出的。
fileCreatedOn	文件的创建时间。
fileId	文件的 fileId。
fileLastWriteOn	文件的上次写入时间。
fileParentId	文件的父 fileId。
filePermissionKey	文件的权限集的键。
isServerEncrypted	如果文件数据和应用程序元数据使用指定的算法完全加密，则此标头的值设置为 true。否则，该值设置为 false（当文件未加密时，或仅加密文件/应用程序元数据的一部分时）。
lastModified	返回上次修改文件的日期和时间。修改文件或其属性的任何作将更新上次修改时间。
leaseDuration	当文件被租用时，指定租约是无限持续时间还是固定持续时间。
leaseState	文件的租用状态。
leaseStatus	文件的当前租约状态。
metadata	作为用户定义的元数据与此文件关联的一组名称/值对。
posixProperties	NFS 文件的属性。
requestId	此标头唯一标识已发出的请求，并可用于对请求进行故障排除。
version	指示用于执行请求的文件服务的版本。

属性详细信息

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

acceptRanges?: string

属性值

string

如果以前为文件指定了它，则返回。

cacheControl?: string

属性值

string

返回为“x-ms-content-disposition”标头指定的值，并指定如何处理响应。

contentDisposition?: string

属性值

string

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

contentEncoding?: string

属性值

string

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

contentLanguage?: string

属性值

string

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

contentLength?: number

属性值

number

如果文件具有 MD5 哈希，并且请求是读取完整文件，则返回此响应标头，以便客户端可以检查消息内容完整性。如果请求读取指定的范围，并且“x-ms-range-get-content-md5”设置为 true，则只要范围大小小于或等于 4 MB，请求将返回该范围的 MD5 哈希。如果这两组条件都不为 true，则不会为“Content-MD5”标头返回任何值。

contentMD5?: Uint8Array

属性值

Uint8Array

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

contentRange?: string

属性值

string

为文件指定的内容类型。默认内容类型为“application/octet-stream”

contentType?: string

属性值

string

上次尝试复制文件作的结束时间，该文件是目标文件。此值可以指定已完成、中止或失败复制尝试的时间。

copyCompletedOn?: Date

属性值

Date

上次尝试的复制文件作的字符串标识符，其中此文件是目标文件。

copyId?: string

属性值

string

包含上次尝试的复制文件作中复制的字节数和源中的总字节数，其中此文件是目标文件。可以显示复制的 0 到内容长度字节。

copyProgress?: string

属性值

string

URL 最大长度为 2KB，指定在上次尝试的复制文件作中使用的源文件，其中此文件是目标文件。

copySource?: string

属性值

string

由“x-ms-copy-id”标识的复制作的状态。

copyStatus?: CopyStatusType

属性值

CopyStatusType

仅当 x-ms-copy-status 失败或挂起时才显示。描述致命或非致命复制作失败的原因。

copyStatusDescription?: string

属性值

string

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

date?: Date

属性值

Date

错误代码

errorCode?: string

属性值

string

ETag 包含一个值，可用于在引号中有条件地执行作。

etag?: string

属性值

string

为文件设置的属性。

fileAttributes?: string

属性值

string

更改文件的时间。

fileChangeOn?: Date

属性值

Date

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

fileContentMD5?: Uint8Array

属性值

Uint8Array

文件的创建时间。

fileCreatedOn?: Date

属性值

Date

文件的 fileId。

fileId?: string

属性值

string

文件的上次写入时间。

fileLastWriteOn?: Date

属性值

Date

文件的父 fileId。

fileParentId?: string

属性值

string

文件的权限集的键。

filePermissionKey?: string

属性值

string

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

isServerEncrypted?: boolean

属性值

boolean

返回上次修改文件的日期和时间。修改文件或其属性的任何作将更新上次修改时间。

lastModified?: Date

属性值

Date

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

leaseDuration?: LeaseDurationType

属性值

LeaseDurationType

文件的租用状态。

leaseState?: LeaseStateType

属性值

LeaseStateType

文件的当前租约状态。

leaseStatus?: LeaseStatusType

属性值

LeaseStatusType

作为用户定义的元数据与此文件关联的一组名称/值对。

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

属性值

{[propertyName: string]: string}

NFS 文件的属性。

posixProperties?: FilePosixProperties

属性值

FilePosixProperties

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

requestId?: string

属性值

string

指示用于执行请求的文件服务的版本。

version?: string

属性值

string