DataLakeDirectoryClient.DeleteFileAsync 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:: DataLakeDirectoryClient.cs

Source:: DataLakeDirectoryClient.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 DeleteFileAsync(String, DataLakeRequestConditions, CancellationToken) operation deletes a file in this directory.

For more information, see Delete Path.

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

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

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

Parameters

fileName: String

The name of the file 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 deleting.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to

Share via