Package version:

Interface BlockBlobParallelUploadOptions

Option interface for BlockBlobClient.uploadFile and BlockBlobClient.uploadSeekableStream.

interface BlockBlobParallelUploadOptions {
    abortSignal?: any;
    blobHTTPHeaders?: BlobHTTPHeaders;
    blockSize?: number;
    concurrency?: number;
    conditions?: BlobRequestConditions;
    encryptionScope?: string;
    maxSingleShotSize?: number;
    metadata?: {
        [propertyName: string]: string;
    };
    onProgress?: ((progress: TransferProgressEvent) => void);
    tags?: any;
    tier?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? blobHTTPHeaders? blockSize? concurrency? conditions? encryptionScope? maxSingleShotSize? metadata? onProgress? tags? tier? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalblobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders

Blob HTTP Headers. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

OptionalblockSize

blockSize?: number

Destination block blob size in bytes.

Optionalconcurrency

concurrency?: number

Concurrency of parallel uploading. Must be greater than or equal to 0.

Optionalconditions

conditions?: BlobRequestConditions

Access conditions headers.

OptionalencryptionScope

encryptionScope?: string

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

OptionalmaxSingleShotSize

maxSingleShotSize?: 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.

Optionalmetadata

metadata?: {
    [propertyName: string]: string;
}

Metadata of block blob.

OptionalonProgress

onProgress?: ((progress: TransferProgressEvent) => void)

Progress updater.

Optionaltags

tags?: any

Blob tags.

Optionaltier

tier?: string

Access tier. More Details - https://learn.microsoft.com/azure/storage/blobs/storage-blob-storage-tiers

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility