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

DeleteContainer

Deletes a container from Azure blob storage.

Task version: 3.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

ContainerName : String

Name of the Azure blob storage container which will be deleted.

Default: - Example: test-container

Name
Description

AuthenticationMethod : ConnectionMethod

Defines which connection method should be used for connecting to Azure Blob Storage.

Possible values:

  • ConnectionString: Defines which connection method should be used for connecting to Azure Blob Storage.

  • OAuth2: Defines which connection method should be used for connecting to Azure Blob Storage.

  • SasToken: Defines which connection method should be used for connecting to Azure Blob Storage.

  • ArcManagedIdentity: Defines which connection method should be used for connecting to Azure Blob Storage.

  • ArcManagedIdentityCrossTenant: Defines which connection method should be used for connecting to Azure Blob Storage.

Default: 1 Example: ConnectionMethod.ConnectionString

🗝ConnectionString : String

Connection string to Azure storage.

Default: - Example: DefaultEndpointsProtocol=https;AccountName=account-name;AccountKey=abc==;EndpointSuffix=core.windows.net

ApplicationId : String

Application (Client) ID of Azure AD Application.

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

TenantId : String

Tenant ID of Azure Tenant.

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

🗝ClientSecret : String

Client Secret of Azure AD Application.

Default: - Example: Password!

🗝SasToken : String

A shared access signature to use when connecting to an Azure storage container.

Grants restricted access rights to Azure Storage resources when combined with URI.

Default: - Example: sv=2021-04-10&se=2022-04-10T10%3A431Z&sr=c&sp=l&sig=ZJg983RovE%23ZXI

StorageAccountName : String

Name of the Azure storage account.

Default: - Example: TestStorage

Scopes : String[]

Scopes used when authenticating with Arc Managed Identity Cross Tenant.

Default: - Example: [api://AzureADTokenExchange/.default]

TargetTenantId : String

Target Tenant ID of Azure Tenant.

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

TargetClientId : String

Target Client ID of Azure Tenant.

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

Name
Description

FailOnContainerNotFound : Boolean

If true, the absence of the container is treated as a task failure.

This failure will be processed according to the 'ThrowErrorOnFailure' setting:

an exception will be thrown if 'ThrowErrorOnFailure' is true, or a Result object with Error details will be returned if false.

If false, a missing container is treated as a valid "no-action" scenario, returning Success = false and Error = null, regardless of the 'ThrowErrorOnFailure' setting.

Default: False Example: -

ThrowErrorOnFailure : Boolean

If true, throws an exception on task failure.

If false, returns a result object with Success = false and Error details.

Default: True Example: true

ErrorMessageOnFailure : String

Optional custom error message included in the exception or result Error.Message on failure.

If left empty, the original exception message is used.

Default: - Example: DeleteContainer failed.

Task Result

Name
Description

Success : Boolean

Returns true when the container was successfully deleted. Returns false when the container was not found and FailOnContainerNotFound is false, or when any failure occurs and ThrowErrorOnFailure is false. Example: true

Error : Error

Error details when the task fails and ThrowErrorOnFailure is false. Null on success. Example: null

Task Changelog

Changelog for Task Frends.AzureBlobStorage.DeleteContainer.

[3.0.0] - 2026-05-04

Breaking changes

  • Options.ThrowErrorIfContainerDoesNotExists renamed to FailOnContainerNotFound. To upgrade: update your process to use FailOnContainerNotFound instead of ThrowErrorIfContainerDoesNotExists.

  • Result.ContainerWasDeleted renamed to Success. To upgrade: update your process to reference Success instead of ContainerWasDeleted.

  • Result.Message removed; error information is now in Result.Error.Message. To upgrade: check Result.Error for error details on failure.

Added

  • Options.ThrowErrorOnFailure (default: true) to control whether the task throws on failure or returns an error result.

  • Options.ErrorMessageOnFailure to provide a custom error message included in the exception or Result.Error.Message.

  • Result.Error structured error object with Message and AdditionalInfo fields.

[2.0.0] - 2026-04-26

Changed

  • Standardized parameter names and validation across all Azure Blob Storage tasks for consistency.

[1.4.0] - 2026-01-26

Added

  • Add options to support Arc Managed Identity authentication.

[1.3.0] - 2026-01-15

Changed

  • Updated Azure packages to the latest versions:

  • Azure.Storage.Blobs 12.27.0

  • Azure.Identity 1.17.1

[1.2.0] - 2024-08-21

Updated

  • Updated Azure.Identity to version 1.12.0.

[1.1.1] - 2024-01-31

Updated

  • Azure.Identity to version 1.10.4

  • Azure.Storage.Blobs to version 12.19.1

[1.1.0] - 2022-12-15

Added

  • OAuth2 as a new additional authentication method.

Changed

  • Dependency update: Removed dependencies: Azure.Storage.Common Azure.Core MimeMapping Microsoft.CSharp System.ComponentModel.Annotations

    Added dependencies: Azure.Identity 1.8.0

    Update dependencies: Azure.Storage.Blobs 12.10.0 to 12.14.1

[1.0.0] - 2022-12-04

Added

  • Initial implementation of Frends.AzureBlobStorage.DeleteContainer.

Last updated

Was this helpful?