ShareClient.DeleteDirectoryAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.21.0

Source:

ShareClient.cs

The DeleteDirectoryAsync(String, CancellationToken) operation removes the specified empty directory.

For more information, see Delete Directory.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDirectoryAsync (string directoryName, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteDirectoryAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDirectoryAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteDirectoryAsync (directoryName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

directoryName

String

The name of the directory to delete.

cancellationToken

CancellationToken

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

Returns

Task<Response>

A Response if successful.

Remarks

Note that the directory must be empty before it can be deleted.