DataLakeFileSystemClient.DeleteDirectoryAsync Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.21.0

Source:

DataLakeFileSystemClient.cs

The DeleteDirectoryAsync(String, DataLakeRequestConditions, CancellationToken) deletes a directory in this file system. garbage collection which could take several minutes.

For more information, see Delete Path.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDirectoryAsync (string path, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteDirectoryAsync : string * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDirectoryAsync : string * Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

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

Parameters

path

String

The path to the directory to delete.

conditions

DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on deleting this path.

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.