ShareDirectoryClient.DeleteFileAsync Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.21.0

Source:

ShareDirectoryClient.cs

The DeleteFile(String, ShareFileRequestConditions, CancellationToken) operation immediately removes the file from the storage account.

For more information, see Delete File.

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

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

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

Parameters

fileName

String

The name of the file.

conditions

ShareFileRequestConditions

Optional ShareFileRequestConditions to add conditions on creating the file.

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.