DataLakeDirectoryClient.DeleteSubDirectory Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.20.1

Source:

DataLakeDirectoryClient.cs

The DeleteSubDirectory(String, String, DataLakeRequestConditions, CancellationToken) deletes a sub directory in this directory.

For more information, see Delete Path.

public virtual Azure.Response DeleteSubDirectory (string path, string continuation = default, Azure.Storage.Files.DataLake.Models.DataLakeRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function DeleteSubDirectory (path As String, Optional continuation As String = Nothing, Optional conditions As DataLakeRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

path

String

The path to the directory to delete.

continuation

String

Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.

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

Response

A Response on successfully deleting.

Remarks

A RequestFailedException will be thrown if a failure occurs.