BlobDownloadOptions interface
ダウンロード 操作を構成するオプション。
- Extends
プロパティ
abort |
操作を取り消す要求を通知する |
conditions | BLOB のダウンロード時に満たす条件。 |
customer |
顧客が提供したキー情報。 |
max |
随意。 NODE.JSでのみ使用できます。 元の本文ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーが出力されないため、パイプラインで定義されている再試行ポリシーはトリガーされません。 このオプションを使用すると、再試行が追加されるたびに、要求された範囲が正常にダウンロードされるか maxRetryRequests に達するまで、中断された時点から追加の デフォルト値は 5 です。ネットワークが不十分な場合は、大きなファイルを読み込むときに大きな値を設定してください。 |
on |
コールバックして、ダウンロード操作の進行状況に関するイベントを受信します。 |
range |
これが true に設定され、BLOB のダウンロード範囲が設定されている場合、範囲が 4 MB 以下である限り、サービスは範囲の CRC64 ハッシュを返します。 rangeGetContentCrc64 と rangeGetContentMD5 を同時に設定することはできません。 |
range |
これが true に設定され、BLOB のダウンロード範囲が設定されている場合、範囲が 4 MB 以下である限り、サービスは範囲の MD5 ハッシュを返します。 rangeGetContentCrc64 と rangeGetContentMD5 を同時に設定することはできません。 |
snapshot | 存在する場合、取得する BLOB スナップショットを指定する不透明な DateTime 文字列値。 |
継承されたプロパティ
tracing |
トレースが有効な場合に作成されるスパンを構成するオプション。 |
プロパティの詳細
abortSignal
操作を取り消す要求を通知する AbortSignalLike
インターフェイスの実装。
たとえば、@azure/abort-controller を使用して AbortSignal
を作成します。
abortSignal?: AbortSignalLike
プロパティ値
conditions
customerProvidedKey
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