BlobDeleteMethodOptionalParams interface

Package:

@azure/storage-blob

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
deleteSnapshots	Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself. Possible values include: 'include', 'only'
leaseAccessConditions	Additional parameters for the operation
modifiedAccessConditions	Additional parameters for the operation
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
requestId	Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
snapshot	The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.
timeout	The number of milliseconds a request can take before automatically being terminated.
timeoutParameter	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

deleteSnapshots

Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself. Possible values include: 'include', 'only'

deleteSnapshots?: DeleteSnapshotsOptionType

Property Value

DeleteSnapshotsOptionType

leaseAccessConditions

Additional parameters for the operation

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

modifiedAccessConditions

Additional parameters for the operation

modifiedAccessConditions?: ModifiedAccessConditions

Property Value

ModifiedAccessConditions

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

requestId

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

requestId?: undefined | string

Property Value

undefined | string

snapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.

snapshot?: undefined | string

Property Value

undefined | string

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: undefined | number

Property Value

undefined | number

timeoutParameter

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

timeoutParameter?: undefined | number

Property Value

undefined | number