DataLakeFileSystemClient.DeleteIfExistsAsync Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.17.1

Source:

DataLakeFileSystemClient.cs

The DeleteIfExistsAsync(DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion if it exists. The file system and any files and directories contained within it are later deleted during garbage collection which could take several minutes.

For more information, see Delete Container.

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

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

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

Parameters

conditions

DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on the deletion of this cofile systemntainer.

cancellationToken

CancellationToken

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

Returns

Task<Response<Boolean>>

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.