DataLakeFileClient.DeleteIfExistsAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

Package:: Azure.Storage.Files.DataLake v12.21.0

Package:: Azure.Storage.Files.DataLake v12.21.0-beta.2

Source:: DataLakeFileClient.cs

Source:: DataLakeFileClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The DeleteIfExistsAsync(DataLakeRequestConditions, CancellationToken) operation marks the specified file for deletion, if the file exists. The file 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<bool>> DeleteIfExistsAsync (Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

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 deleting this path.

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.

Applies to

Share via