BlobDownloadOptions interface

參考

套件:: @azure/storage-blob

設定 <xref:BlobClient.download> 作業的選項。

Extends: CommonOptions

屬性

abortSignal	介面的 `AbortSignalLike` 實作，可發出要求以取消作業的訊號。例如，使用 @azure/abort-controller 來建立 `AbortSignal` 。
conditions	下載 Blob 時要符合的條件。
customerProvidedKey	客戶提供的金鑰資訊。
maxRetryRequests	選擇性。僅適用于 NODE.JS。原始本文下載資料流程未預期結束時，將會執行多少次重試。上述類型的結尾不會觸發管線中定義的重試原則，因為它們不會發出網路錯誤。使用此選項時，每次額外的重試都會從中中斷點提出額外的 `FileClient.download()` 要求，直到成功下載要求的範圍或達到 maxRetryRequests 為止。預設值為 5，請在載入網路不佳的大型檔案時設定較大的值。
onProgress	回呼以接收下載作業進度的事件。
rangeGetContentCrc64	當此設定為 true 並下載 Blob 範圍時，只要範圍小於或等於大小為 4 MB，服務就會傳回該範圍的 CRC64 雜湊。 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 範圍時，只要範圍小於或等於大小為 4 MB，服務就會傳回該範圍的 CRC64 雜湊。 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

共用方式為