BlobDownloadOptions interface

パッケージ:

@azure/storage-blob

操作を構成するための <xref:BlobClient.download> オプション。

Extends

CommonOptions

プロパティ

abortSignal	操作を AbortSignalLike 取り消す要求を通知するインターフェイスの実装。 たとえば、@azure/abort-controller を使用して を作成します AbortSignal。
conditions	BLOB のダウンロード時に満たす条件。
customerProvidedKey	顧客提供のキー情報。
maxRetryRequests	省略可能。 NODE.JSでのみ使用できます。 元の本文ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーを出力しないため、パイプラインで定義された再試行ポリシーはトリガーされません。 このオプションを使用すると、再試行が追加されるたびに、要求された範囲が正常にダウンロードされるか maxRetryRequests に達するまで、中断されたポイントから追加 FileClient.download() の要求が行われます。 既定値は 5 です。ネットワークが不足している大きなファイルを読み込む場合は、大きな値を設定してください。
onProgress	コールバックして、ダウンロード操作の進行状況に関するイベントを受信します。
rangeGetContentCrc64	これが true に設定され、BLOB のダウンロード範囲が設定されている場合、範囲のサイズが 4 MB 以下である限り、サービスは範囲の CRC64 ハッシュを返します。 rangeGetContentCrc64 と rangeGetContentMD5 を同時に設定することはできません。
rangeGetContentMD5	これが true に設定され、BLOB のダウンロード範囲が設定されている場合、範囲のサイズが 4 MB 以下である限り、サービスは範囲の MD5 ハッシュを返します。 rangeGetContentCrc64 と rangeGetContentMD5 を同時に設定することはできません。
snapshot	取得する BLOB スナップショットを指定する、不透明な DateTime 文字列値。
tracingOptions	トレースが有効になっているときに作成されたスパンを構成するためのオプション。

プロパティの詳細

abortSignal

操作を AbortSignalLike 取り消す要求を通知するインターフェイスの実装。 たとえば、@azure/abort-controller を使用して を作成します AbortSignal。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

conditions

BLOB のダウンロード時に満たす条件。

conditions?: BlobRequestConditions

プロパティ値

BlobRequestConditions

customerProvidedKey

顧客提供のキー情報。

customerProvidedKey?: CpkInfo

プロパティ値

CpkInfo

maxRetryRequests

省略可能。 NODE.JSでのみ使用できます。 元の本文ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーを出力しないため、パイプラインで定義された再試行ポリシーはトリガーされません。

このオプションを使用すると、再試行が追加されるたびに、要求された範囲が正常にダウンロードされるか maxRetryRequests に達するまで、中断されたポイントから追加 FileClient.download() の要求が行われます。

既定値は 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 のダウンロード範囲が設定されている場合、範囲のサイズが 4 MB 以下である限り、サービスは範囲の MD5 ハッシュを返します。 rangeGetContentCrc64 と rangeGetContentMD5 を同時に設定することはできません。

rangeGetContentMD5?: boolean

プロパティ値

boolean

snapshot

取得する BLOB スナップショットを指定する、不透明な DateTime 文字列値。

snapshot?: string

プロパティ値

string

tracingOptions

トレースが有効になっているときに作成されたスパンを構成するためのオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions