Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BlockBlobUploadOptions

Package version

Options to configure BlockBlobClient.upload operation.

export
interface

BlockBlobUploadOptions

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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

BlockBlobUploadOptions

Optional blobHTTPHeaders

blobHTTPHeaders: BlobHTTPHeaders

HTTP headers to set when uploading to a block blob.

type

{BlobHTTPHeaders}

memberof

BlockBlobUploadOptions

Optional conditions

Conditions to meet when uploading to the block blob.

type

{BlobRequestConditions}

memberof

BlockBlobUploadOptions

Optional customerProvidedKey

customerProvidedKey: CpkInfo

Customer Provided Key Info.

type

{CpkInfo}

memberof

BlockBlobUploadOptions

Optional metadata

metadata: Metadata

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

type

{Metadata}

memberof

BlockBlobUploadOptions

Optional onProgress

onProgress: undefined | function

Callback to receive events on the progress of upload operation.

type

{(progress: TransferProgressEvent) => void}

memberof

BlockBlobUploadOptions

Optional tier

tier: BlockBlobTier | string
type

{BlockBlobTier | string}

memberof

BlockBlobUploadOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc