For the complete documentation index, see llms.txt. This page is also available as Markdown.

DeleteDirectory

Frends Task for deleting a directory in Azure Data Lake container.

Task version: 1.4.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

ConnectionMethod : ConnectionMethod

Which connection method should be used for connecting to Azure Data Lake.

Possible values:

  • ConnectionString: Which connection method should be used for connecting to Azure Data Lake.

  • OAuth2: Which connection method should be used for connecting to Azure Data Lake.

Default: ConnectionString Example: ConnectionMethod.ConnectionString

🗝ConnectionString : String

Connection string to Azure Data Lake.

Default: - Example: DefaultEndpointsProtocol=https;AccountName=accountname;AccountKey=Pdlrxyz==;EndpointSuffix=core.windows.net

StorageAccountName : String

Name of the Azure Data Lake account.

Default: - Example: storager

ApplicationID : String

Application (Client) ID of Azure AD Application.

Default: - Example: Y6b1hf2a-80e2-xyz2-qwer3h-3a7c3a8as4b7f

TenantID : String

Tenant ID of Azure Tenant.

Default: - Example: Y6b1hf2a-80e2-xyz2-qwer3h-3a7c3a8as4b7f

🗝ClientSecret : String

Client Secret of Azure AD Application.

Default: - Example: Password!

ContainerName : String

Name of the Azure Data Lake container.

Naming: lowercase

Valid chars: alphanumeric and dash, but cannot start or end with dash.

Default: test-container Example: test-container

DirectoryName : String

Name of the Azure Data Lake directory.

Valid chars: alphanumeric.

Default: directory_name Example: directory_name

Name
Description

ThrowErrorOnFailure : Boolean

True: Throw an exception on failure.

False: Return Result with Success=false and Error with description of exception.

Default: True Example: true

ErrorMessageOnFailure : String

Custom error message to include when an error occurs.

Leave empty to use the original exception message.

Default: - Example: Custom error message here

Task Result

Name
Description

Success : Boolean

Indicates whether the operation succeeded. Example: true

DirectoryWasDeleted : Boolean

Returns true if directory has been deleted. Example: true

Message : String

Description about action's result. Example: Directory deleted successfully.

Error : Error

Error information if the operation failed and ThrowErrorOnFailure is false.

Error.Message : String

Error message describing what went wrong. Example: The specified resource does not exist.

Error.AdditionalInfo : Exception

The exception that caused the error.

Task Changelog

Changelog for Task Frends.AzureDataLake.DeleteDirectory.

[1.4.0] - 2026-08-07

Added

  • Added an Options parameter with ThrowErrorOnFailure and ErrorMessageOnFailure settings to control error handling behavior. When ThrowErrorOnFailure is set to false, the task returns a result with Success = false and error details instead of throwing an exception.

  • The result now includes Success and Error properties for easier error checking.

Changed

  • Upgraded target framework from .NET 6 to .NET 8.

[1.3.0] - 2026-01-15

Changed

  • Updated Azure packages to latest versions:

  • Azure.Storage.Files.DataLake 12.25.0

  • Azure.Identity 1.17.1

[1.2.0] - 2025-12-12

Changed

  • Update description of the task.

[1.1.0] - 2024-08-23

Changed

  • Updated the Azure.Identity package to version 1.12.0.

[1.0.0] - 2024-05-14

Added

  • Initial implementation of Frends.AzureDataLake.DeleteDirectory.

Last updated

Was this helpful?