BlockBlobUploadStreamOptions interface

Package:

@azure/storage-blob

Option interface for the <xref:BlockBlobClient.uploadStream> 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	Blob HTTP Headers. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.
conditions	Access conditions headers.
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.
metadata	Metadata of block blob.
onProgress	Progress updater.
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

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

blobHTTPHeaders?: BlobHTTPHeaders

Property Value

BlobHTTPHeaders

conditions

Access conditions headers.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

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

metadata

Metadata of block blob.

metadata?: [key: string]: string

Property Value

[key: string]: string

onProgress

Progress updater.

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