ShareServiceClient.DeleteShare(String, 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.

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 Azure.Response DeleteShare (string shareName, Azure.Storage.Files.Shares.Models.ShareDeleteOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteShare : string * Azure.Storage.Files.Shares.Models.ShareDeleteOptions * System.Threading.CancellationToken -> Azure.Response
override this.DeleteShare : string * Azure.Storage.Files.Shares.Models.ShareDeleteOptions * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteShare (shareName As String, options As ShareDeleteOptions, Optional cancellationToken As CancellationToken = Nothing) As 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

Response

A Response on successfully deleting.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to