FileDownloadOptions interface

ファイル - ダウンロード操作を構成するためのオプション。参照トピック

プロパティ

abortSignal	操作を `AbortSignalLike` 取り消す要求を通知するインターフェイスの実装。たとえば、@azure/abort-controller を使用してを作成します `AbortSignal`。
leaseAccessConditions	リースアクセス条件。
maxRetryRequests	省略可能。 NODE.JSでのみ使用できます。元の本文ダウンロードストリームの予期しない終了時に実行される再試行回数。上記の種類の終了では、ネットワークエラーを出力しないため、パイプラインで定義されている再試行ポリシーはトリガーされません。このオプションを使用すると、再試行するたびに、要求された範囲が正常にダウンロードされるか、maxRetryRequests に達するまで、破損したポイントから追加の ShareFileClient.download() 要求が行われます。既定値は 5 です。ネットワークの不十分なサイズのファイルを読み込む場合は、大きな値を設定してください。
onProgress	進行状況更新イベントハンドラーをダウンロードします。
rangeGetContentMD5	このヘッダーが true に設定され、Range ヘッダーと共に指定されると、範囲のサイズが 4 MB 以下である限り、サービスは範囲の MD5 ハッシュを返します。

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

abortSignal?: AbortSignalLike

AbortSignalLike

リースアクセス条件。

leaseAccessConditions?: LeaseAccessConditions

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

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

既定値は 5 です。ネットワークの不十分なサイズのファイルを読み込む場合は、大きな値を設定してください。

maxRetryRequests?: number

number

進行状況更新イベントハンドラーをダウンロードします。

onProgress?: (progress: TransferProgressEvent) => void

(progress: TransferProgressEvent) => void

このヘッダーが true に設定され、Range ヘッダーと共に指定されると、範囲のサイズが 4 MB 以下である限り、サービスは範囲の MD5 ハッシュを返します。

rangeGetContentMD5?: boolean

boolean

tracingOptions?: OperationTracingOptions

OperationTracingOptions