Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
FileParallelUploadOptions interface
- Package:
- @azure/storage-file-share
Option interface for File - Upload operations
See:
- uploadFile
- <xref:ShareFileClient.uploadSeekableStream>
- Extends
Properties
| abortSignal | An implementation of the |
| concurrency | Concurrency indicates the maximum number of ranges to upload in parallel. If not provided, 5 concurrency will be used by default. |
| contentChecksumAlgorithm | Options to indication which algorithm to use for content validation in uploading. |
| fileHttpHeaders | File HTTP Headers. |
| leaseAccessConditions | Lease access conditions. |
| metadata | Metadata of an Azure file. |
| onProgress | Progress updater. |
| rangeSize | RangeSize specifies the range size to use in each parallel upload, the default (and maximum size) is FILE_RANGE_MAX_SIZE_BYTES. |
Inherited Properties
| tracingOptions |
Property Details
abortSignal
An implementation of the AbortSignalLike interface to signal the request to cancel the operation.
For example, use the @azure/abort-controller to create an AbortSignal.
abortSignal?: AbortSignalLikeProperty Value
concurrency
Concurrency indicates the maximum number of ranges to upload in parallel. If not provided, 5 concurrency will be used by default.
concurrency?: numberProperty Value
number
contentChecksumAlgorithm
Options to indication which algorithm to use for content validation in uploading.
contentChecksumAlgorithm?: StorageChecksumAlgorithmProperty Value
fileHttpHeaders
leaseAccessConditions
Lease access conditions.
leaseAccessConditions?: LeaseAccessConditionsProperty Value
metadata
onProgress
Progress updater.
onProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
rangeSize
RangeSize specifies the range size to use in each parallel upload, the default (and maximum size) is FILE_RANGE_MAX_SIZE_BYTES.
rangeSize?: numberProperty Value
number