BlobDownloadToBufferOptions interface

套件:

@azure/storage-blob

downloadToBuffer 作業的選項介面。

Extends

CommonOptions

屬性

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

屬性值

AbortSignalLike

blockSize

blockSize 是嘗試下載的每個要求的數據。 必須大於或等於 0。 如果設定為 0 或未定義，blockSize 就會根據 Blob 大小自動計算。

blockSize?: number

屬性值

number

concurrency

並行下載。

concurrency?: number

屬性值

number

conditions

存取條件標頭。

conditions?: BlobRequestConditions

屬性值

BlobRequestConditions

customerProvidedKey

客戶提供的金鑰資訊。

customerProvidedKey?: CpkInfo

屬性值

CpkInfo

maxRetryRequestsPerBlock

自選。 僅適用於 NODE.JS。

原始區塊下載數據流非預期結束時，將會執行多少次重試。 上述類型的結束不會觸發管線中定義的重試原則，因為它們不會發出網路錯誤。

使用此選項時，每個額外的重試表示會從中斷點提出額外的 FileClient.download（） 要求，直到成功下載要求的區塊或達到 maxRetryRequestsPerBlock 為止。

默認值為 5，當網路不佳時，請設定較大的值。

maxRetryRequestsPerBlock?: number

屬性值

number

onProgress

進度更新程式。

onProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承的屬性詳細資料

tracingOptions

設定啟用追蹤時所建立範圍的選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions