Share via

BlobDeleteOptions interface

Package:
@azure/storage-blob

Options to configure the delete 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.
conditions

Conditions to meet when deleting blobs.
customerProvidedKey

Customer Provided Key Info.
deleteSnapshots

Specifies options to delete blobs that have associated snapshots.

  • include: Delete the base blob and all of its snapshots.
  • only: Delete only the blob's snapshots and not the blob itself.

Inherited Properties

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

conditions

Conditions to meet when deleting blobs.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

deleteSnapshots

Specifies options to delete blobs that have associated snapshots.

  • include: Delete the base blob and all of its snapshots.
  • only: Delete only the blob's snapshots and not the blob itself.
deleteSnapshots?: DeleteSnapshotsOptionType

Property Value

DeleteSnapshotsOptionType

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions