DataLakePathClient.DeleteAsync Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.17.1

Source:

DataLakePathClient.cs

The DeleteAsync(Nullable<Boolean>, 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 System.Threading.Tasks.Task<Azure.Response> DeleteAsync (bool? recursive = default, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function DeleteAsync (Optional recursive As Nullable(Of Boolean) = Nothing, Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

recursive

Nullable<Boolean>

Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs.

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.