次の方法で共有


FileDownloadToBufferOptions interface

downloadToBuffer 操作のオプション インターフェイス。

Extends

プロパティ

abortSignal

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

concurrency

コンカレンシーは、並列でダウンロードする範囲の最大数を示します。 指定しない場合は、既定で 5 つのコンカレンシーが使用されます。

leaseAccessConditions

リース アクセス条件。

maxRetryRequestsPerRange

随意。 NODE.JSでのみ使用できます。

元の範囲ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーが出力されないため、パイプラインで定義されている再試行ポリシーはトリガーされません。

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

デフォルト値は5で、ネットワークが悪い場合は大きな値を設定してください。

onProgress

進行状況アップデーター。

rangeSize

Azure ファイルをダウンロードする場合、ダウンロード方法は大きなファイルを小さな範囲に分割しようとします。 すべての小さな範囲は、個別の要求を介してダウンロードされます。 このオプションは、ダウンロードしようとする小さな要求ごとにサイズ データを定義します。 0 より大きい必要があります。未定義の場合は既定値が使用されます。

継承されたプロパティ

tracingOptions

プロパティの詳細

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

concurrency

コンカレンシーは、並列でダウンロードする範囲の最大数を示します。 指定しない場合は、既定で 5 つのコンカレンシーが使用されます。

concurrency?: number

プロパティ値

number

leaseAccessConditions

リース アクセス条件。

leaseAccessConditions?: LeaseAccessConditions

プロパティ値

maxRetryRequestsPerRange

随意。 NODE.JSでのみ使用できます。

元の範囲ダウンロード ストリームの予期しない終了時に実行される再試行回数。 上記の種類の終了では、ネットワーク エラーが出力されないため、パイプラインで定義されている再試行ポリシーはトリガーされません。

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

デフォルト値は5で、ネットワークが悪い場合は大きな値を設定してください。

maxRetryRequestsPerRange?: number

プロパティ値

number

onProgress

進行状況アップデーター。

onProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

rangeSize

Azure ファイルをダウンロードする場合、ダウンロード方法は大きなファイルを小さな範囲に分割しようとします。 すべての小さな範囲は、個別の要求を介してダウンロードされます。 このオプションは、ダウンロードしようとする小さな要求ごとにサイズ データを定義します。 0 より大きい必要があります。未定義の場合は既定値が使用されます。

rangeSize?: number

プロパティ値

number

継承されたプロパティの詳細

tracingOptions

tracingOptions?: OperationTracingOptions

プロパティ値

継承元CommonOptions.tracingOptions