Share via


ShareClient.DeleteAsync(ShareDeleteOptions, CancellationToken) Method

Definition

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.

For more information, see Delete Share.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (Azure.Storage.Files.Shares.Models.ShareDeleteOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Azure.Storage.Files.Shares.Models.ShareDeleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteAsync : Azure.Storage.Files.Shares.Models.ShareDeleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteAsync (options As ShareDeleteOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

options
ShareDeleteOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to