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

BlobDownloadOptions interface

用于配置 下载 操作的选项。

Extends

属性

abortSignal

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

conditions

下载 Blob 时要满足的条件。

customerProvidedKey

客户提供的密钥信息。

maxRetryRequests

可选。 仅在 NODE.JS 中可用。

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

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

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

onProgress

回调以接收有关下载操作进度的事件。

rangeGetContentCrc64

如果此值设置为 true 并下载 blob 范围,则服务将返回该范围的 CRC64 哈希,前提是该范围的大小小于或等于 4 MB。

rangeGetContentCrc64 和 rangeGetContentMD5 不能同时设置。

rangeGetContentMD5

如果此值设置为 true 并下载 blob 范围,则服务将返回该范围的 MD5 哈希,前提是该范围的大小小于或等于 4 MB。

rangeGetContentCrc64 和 rangeGetContentMD5 不能同时设置。

snapshot

一个不透明的 DateTime 字符串值,如果存在,则指定要检索的 Blob 快照。

继承属性

tracingOptions

用于配置启用跟踪时创建的跨度的选项。

属性详细信息

abortSignal

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

abortSignal?: AbortSignalLike

属性值

conditions

下载 Blob 时要满足的条件。

conditions?: BlobRequestConditions

属性值

customerProvidedKey

客户提供的密钥信息。

customerProvidedKey?: CpkInfo

属性值

maxRetryRequests

可选。 仅在 NODE.JS 中可用。

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

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

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

maxRetryRequests?: number

属性值

number

onProgress

回调以接收有关下载操作进度的事件。

onProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

rangeGetContentCrc64

如果此值设置为 true 并下载 blob 范围,则服务将返回该范围的 CRC64 哈希,前提是该范围的大小小于或等于 4 MB。

rangeGetContentCrc64 和 rangeGetContentMD5 不能同时设置。

rangeGetContentCrc64?: boolean

属性值

boolean

rangeGetContentMD5

如果此值设置为 true 并下载 blob 范围,则服务将返回该范围的 MD5 哈希,前提是该范围的大小小于或等于 4 MB。

rangeGetContentCrc64 和 rangeGetContentMD5 不能同时设置。

rangeGetContentMD5?: boolean

属性值

boolean

snapshot

一个不透明的 DateTime 字符串值,如果存在,则指定要检索的 Blob 快照。

snapshot?: string

属性值

string

继承属性详细信息

tracingOptions

用于配置启用跟踪时创建的跨度的选项。

tracingOptions?: OperationTracingOptions

属性值

继承自CommonOptions.tracingOptions