DataLakeFileSystemClient.DeleteDirectory Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.20.1

Source:

DataLakeFileSystemClient.cs

The DeleteDirectory(String, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion. The path is later deleted during garbage collection which could take several minutes.

For more information, see Delete Path.

public virtual Azure.Response DeleteDirectory (string path, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function DeleteDirectory (path As String, Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.