Share via


IFileSystemOperations.DeleteWithHttpMessagesAsync Method

Definition

Deletes the requested file or directory, optionally recursively.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataLake.Store.Models.FileOperationResult>> DeleteWithHttpMessagesAsync (string accountName, string filePath, bool? recursive = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataLake.Store.Models.FileOperationResult>> DeleteWithHttpMessagesAsync (string accountName, string path, bool? recursive = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataLake.Store.Models.FileOperationResult>>
abstract member DeleteWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataLake.Store.Models.FileOperationResult>>
Public Function DeleteWithHttpMessagesAsync (accountName As String, filePath As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of FileOperationResult))
Public Function DeleteWithHttpMessagesAsync (accountName As String, path As String, Optional recursive As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of FileOperationResult))

Parameters

accountName
String

The Azure Data Lake Store account to execute filesystem operations on.

filePathpath
String

The Data Lake Store path (starting with '/') of the file or directory to delete.

recursive
Nullable<Boolean>

The optional switch indicating if the delete should be recursive

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to