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

BlobDownloadToBufferOptions interface

downloadToBuffer 操作的选项接口。

Extends

属性

abortSignal

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

blockSize

blockSize 是尝试下载的每个请求的数据。 必须大于或等于 0。 如果设置为 0 或未定义,则 blockSize 将根据 Blob 大小自动计算。

concurrency

并行下载的并发性。

conditions

访问条件标头。

customerProvidedKey

客户提供的密钥信息。

maxRetryRequestsPerBlock

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

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

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

默认值为 5,请在网络较差时设置更大的值。

onProgress

进度更新程序。

继承属性

tracingOptions

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

属性详细信息

abortSignal

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

abortSignal?: AbortSignalLike

属性值

blockSize

blockSize 是尝试下载的每个请求的数据。 必须大于或等于 0。 如果设置为 0 或未定义,则 blockSize 将根据 Blob 大小自动计算。

blockSize?: number

属性值

number

concurrency

并行下载的并发性。

concurrency?: number

属性值

number

conditions

访问条件标头。

conditions?: BlobRequestConditions

属性值

customerProvidedKey

客户提供的密钥信息。

customerProvidedKey?: CpkInfo

属性值

maxRetryRequestsPerBlock

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

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

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

默认值为 5,请在网络较差时设置更大的值。

maxRetryRequestsPerBlock?: number

属性值

number

onProgress

进度更新程序。

onProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承属性详细信息

tracingOptions

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

tracingOptions?: OperationTracingOptions

属性值

继承自CommonOptions.tracingOptions