BlobDownloadOptions interface

套件:

@azure/storage-blob

設定 下載 作業的選項。

Extends

CommonOptions

屬性

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

屬性值

AbortSignalLike

conditions

下載 Blob 時符合的條件。

conditions?: BlobRequestConditions

屬性值

BlobRequestConditions

customerProvidedKey

客戶提供的金鑰資訊。

customerProvidedKey?: CpkInfo

屬性值

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

屬性值

OperationTracingOptions

繼承自CommonOptions.tracingOptions