DataLakeServiceClient.DeleteFileSystemAsync Method

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

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

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

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

Source:: DataLakeServiceClient.cs

Source:: DataLakeServiceClient.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 DeleteFileSystemAsync(String, DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion. The file system and any paths contained within it are later deleted during garbage collection which could take several minutes.

For more information, see Delete Container.

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

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

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

Parameters

fileSystemName: String

The name of the file system to delete.

conditions: DataLakeRequestConditions

Optional DataLakeRequestConditions to add conditions on the deletion of this file system.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response>

A Response on successfully marking for deletion.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to