BlockBlobParallelUploadOptions | @azure/storage-blob

Option interface for BlockBlobClient.uploadFile and {@link BlockBlobClient.uploadSeekableStream}.

export
interface: BlockBlobParallelUploadOptions

Hierarchy

CommonOptions
- BlockBlobParallelUploadOptions

Index

Properties

Optional 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.

type: {AbortSignalLike}
memberof: BlockBlobParallelUploadOptions

Optional blobHTTPHeaders

blobHTTPHeaders: BlobHTTPHeaders

Blob HTTP Headers.

type: {BlobHTTPHeaders}
memberof: BlockBlobParallelUploadOptions

Optional blockSize

blockSize: undefined | number

Destination block blob size in bytes.

type: {number}
memberof: BlockBlobParallelUploadOptions

Optional concurrency

concurrency: undefined | number

Concurrency of parallel uploading. Must be >= 0.

type: {number}
memberof: BlockBlobParallelUploadOptions

Optional conditions

conditions: BlobRequestConditions

Access conditions headers.

type: {BlobRequestConditions}
memberof: BlockBlobParallelUploadOptions

Optional maxSingleShotSize

maxSingleShotSize: undefined | number

Blob size threshold in bytes to start concurrency uploading. Default value is 256MB, blob size less than this option will be uploaded via one I/O operation without concurrency. You can customize a value less equal than the default value.

type: {number}
memberof: BlockBlobParallelUploadOptions

Optional metadata

metadata: undefined | object

Metadata of block blob.

type: {{ [propertyName: string]: string }}
memberof: BlockBlobParallelUploadOptions

Optional onProgress

onProgress: undefined | function

Progress updater.

type: {(progress: TransferProgressEvent) => void}
memberof: BlockBlobParallelUploadOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.