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

FileDownloadOptions interface

Extends

属性

abortSignal

接口的实现, AbortSignalLike 用于向取消操作的请求发出信号。 例如,使用 @azure/abort-controller 创建 AbortSignal

leaseAccessConditions

租约访问条件。

maxRetryRequests

可选。 仅在 NODE.JS 中可用。 原始正文下载流意外结束时将执行的重试次数。 上述类型的结束不会触发管道中定义的重试策略,因为它们不会发出网络错误。

使用此选项时,每次额外的重试意味着将从断点发出额外的 ShareFileClient.download () 请求,直到成功下载请求的范围或达到 maxRetryRequests。

默认值为 5,请在不良网络中加载大型文件时设置更大的值。

onProgress

下载进度更新事件处理程序。

rangeGetContentMD5

如果此标头设置为 true 并与 Range 标头一起指定,则服务将返回该区域的 MD5 哈希,前提是该范围的大小小于或等于 4 MB。

继承属性

tracingOptions

属性详细信息

abortSignal

接口的实现, AbortSignalLike 用于向取消操作的请求发出信号。 例如,使用 @azure/abort-controller 创建 AbortSignal

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

leaseAccessConditions

租约访问条件。

leaseAccessConditions?: LeaseAccessConditions

属性值

maxRetryRequests

可选。 仅在 NODE.JS 中可用。 原始正文下载流意外结束时将执行的重试次数。 上述类型的结束不会触发管道中定义的重试策略,因为它们不会发出网络错误。

使用此选项时,每次额外的重试意味着将从断点发出额外的 ShareFileClient.download () 请求,直到成功下载请求的范围或达到 maxRetryRequests。

默认值为 5,请在不良网络中加载大型文件时设置更大的值。

maxRetryRequests?: number

属性值

number

onProgress

下载进度更新事件处理程序。

onProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

rangeGetContentMD5

如果此标头设置为 true 并与 Range 标头一起指定,则服务将返回该区域的 MD5 哈希,前提是该范围的大小小于或等于 4 MB。

rangeGetContentMD5?: boolean

属性值

boolean

继承属性详细信息

tracingOptions

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自CommonOptions.tracingOptions