FileParallelUploadOptions interface

Package:

@azure/storage-file-share

Option interface for File - Upload operations

See:

• uploadFile
• <xref:ShareFileClient.uploadSeekableStream>

Extends

CommonOptions

Properties

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.
concurrency	Concurrency indicates the maximum number of ranges to upload in parallel. If not provided, 5 concurrency will be used by default.
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?: AbortSignalLike

Property Value

AbortSignalLike

concurrency

Concurrency indicates the maximum number of ranges to upload in parallel. If not provided, 5 concurrency will be used by default.

concurrency?: number

Property Value

number

fileHttpHeaders

File HTTP Headers.

fileHttpHeaders?: FileHttpHeaders

Property Value

FileHttpHeaders

leaseAccessConditions

Lease access conditions.

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

metadata

Metadata of an Azure file.

metadata?: Metadata

Property Value

Metadata

onProgress

Progress updater.

onProgress?: (progress: TransferProgressEvent) => void

Property 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?: number

Property Value

number

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions