Package version:

Interface BlockBlobUploadOptions

Options to configure BlockBlobClient.upload operation.

interface BlockBlobUploadOptions {
    abortSignal?: any;
    blobHTTPHeaders?: BlobHTTPHeaders;
    conditions?: BlobRequestConditions;
    customerProvidedKey?: CpkInfo;
    encryptionScope?: string;
    immutabilityPolicy?: BlobImmutabilityPolicy;
    legalHold?: boolean;
    metadata?: Metadata;
    onProgress?: ((progress: TransferProgressEvent) => void);
    tags?: any;
    tier?: string;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? blobHTTPHeaders? conditions? customerProvidedKey? encryptionScope? immutabilityPolicy? legalHold? 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

HTTP headers to set when uploading to a block blob. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

Optionalconditions

conditions?: BlobRequestConditions

Conditions to meet when uploading to the block blob.

OptionalcustomerProvidedKey

customerProvidedKey?: CpkInfo

Customer Provided Key Info.

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.

OptionalimmutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

OptionallegalHold

legalHold?: boolean

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

Optionalmetadata

metadata?: Metadata

A collection of key-value string pair to associate with the blob when uploading to a block blob.

OptionalonProgress

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

Callback to receive events on the progress of upload operation.

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