ShareServiceClient.DeleteShareAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
A Response on successfully marking for deletion.
Remarks
A RequestFailedException will be thrown if a failure occurs.
