ShareServiceClient.DeleteShareAsync Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.21.0

Source:

ShareServiceClient.cs

Marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection which could take several minutes.

Currently, this method will always delete snapshots. There's no way to specify a separate value for x-ms-delete-snapshots.

For more information, see Delete Share.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteShareAsync (string shareName, Azure.Storage.Files.Shares.Models.ShareDeleteOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteShareAsync : string * Azure.Storage.Files.Shares.Models.ShareDeleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteShareAsync : string * Azure.Storage.Files.Shares.Models.ShareDeleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteShareAsync (shareName As String, options As ShareDeleteOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

shareName

String

The name of the share to delete.

options

ShareDeleteOptions

Optional parameters.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response>

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.