BlockBlobUploadOptions interface

Package:

@azure/storage-blob

Options to configure <xref:BlockBlobClient.upload> operation.

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.
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.
conditions	Conditions to meet when uploading to the block blob.
customerProvidedKey	Customer Provided Key Info.
encryptionScope	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.
immutabilityPolicy	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.
legalHold	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.
metadata	A collection of key-value string pair to associate with the blob when uploading to a block blob.
onProgress	Callback to receive events on the progress of upload operation.
tags	Blob tags.
tier	Access tier. More Details - https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
tracingOptions	Options to configure spans created when tracing is enabled.

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

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.

blobHTTPHeaders?: BlobHTTPHeaders

Property Value

BlobHTTPHeaders

conditions

Conditions to meet when uploading to the block blob.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

encryptionScope

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.

encryptionScope?: string

Property Value

string

immutabilityPolicy

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.

immutabilityPolicy?: BlobImmutabilityPolicy

Property Value

BlobImmutabilityPolicy

legalHold

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.

legalHold?: boolean

Property Value

boolean

metadata

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

metadata?: Metadata

Property Value

Metadata

onProgress

Callback to receive events on the progress of upload operation.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

tags

Blob tags.

tags?: Tags

Property Value

Tags

tier

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

tier?: BlockBlobTier | string

Property Value

BlockBlobTier | string

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions