Share via

ShareDeleteMethodOptions interface

Package:
@azure/storage-file-share

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.
deleteSnapshots

Specifies the option include to delete the base share and all of its snapshots. Possible values include: 'include'
leaseAccessConditions

If specified, the operation only succeeds if the resource's lease is active and matches this ID.

Inherited Properties

tracingOptions

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

deleteSnapshots

Specifies the option include to delete the base share and all of its snapshots. Possible values include: 'include'

deleteSnapshots?: DeleteSnapshotsOptionType

Property Value

DeleteSnapshotsOptionType

leaseAccessConditions

If specified, the operation only succeeds if the resource's lease is active and matches this ID.

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

Inherited Property Details

tracingOptions 

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions