DeleteBlob
Delete a single blob from Azure Blob Storage.
Task version: 3.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.AzureBlobStorage/tree/main/Frends.AzureBlobStorage.DeleteBlob
Task Parameters
ContainerName : String
Name of the Azure Blob Storage container where the data will be uploaded.
Naming: lowercase
Valid chars: alphanumeric and dash, but cannot start or end with dash.
Default: test-container
Example: test-container
BlobName : String
Name of the blob to delete.
Default: -
Example: TestFile.xml
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
SnapshotDeleteOption : SnapshotDeleteOption
What should be done with blob snapshots?
Possible values:
None: What should be done with blob snapshots?IncludeSnapshots: What should be done with blob snapshots?DeleteSnapshotsOnly: What should be done with blob snapshots?
Default: 1
Example: IncludeSnapshots
VerifyETagWhenDeleting : String
Delete blob only if the ETag matches. Leave empty if verification is not needed.
Default: -
Example: 0x9FE13BAA323E5A4
FailOnBlobNotFound : Boolean
If true, the absence of the blob is treated as a failure that triggers the 'ThrowErrorOnFailure' policy (potentially throwing an exception).
If false, the method returns Success = false with a 'DeleteBlobError' object, but wont't throw an exception for this reason, regardless of the 'ThrowErrorOnFailure' setting.
Default: False
Example: false
ThrowErrorOnFailure : Boolean
If true, the task throws an exception on failure.
If false, the task returns Success = false with error details in the Error property.
Default: True
Example: true
ErrorMessageOnFailure : String
Optional custom error message prefix included in the exception or result Error.Message on failure.
If left empty, the original error message is used.
Default: -
Example: DeleteBlob failed for my-container/my-blob.txt
Task Result
Success : Boolean
True if the blob was successfully deleted. False if the blob did not exist or if an error occurred (and 'ThrowErrorOnFailure' is false).
Example: true
Error : DeleteBlobError
Error information when Success is false. object { string Message, object AdditionalInfo }
Example: null
Task Changelog
Changelog for Task Frends.AzureBlobStorage.DeleteBlob.
[3.0.0] - 2026-05-04
Changed
[Breaking] Renamed
ThrowErrorIfBlobDoesNotExiststoFailOnBlobNotFoundin Options tab.To upgrade: set
FailOnBlobNotFoundto the same value as the oldThrowErrorIfBlobDoesNotExists.
[Breaking] Removed
Infofrom result; replaced withError { Message, AdditionalInfo }.To upgrade: update any process steps reading
result.Infoto useresult.Error.Messageinstead.
Added
Added
ThrowErrorOnFailure(default:true) to Options tab for standardised error handling.Added
ErrorMessageOnFailureto Options tab for a custom error message prefix on failure.
[2.0.0] - 2026-04-26
Changed
Standardized parameter names and validation across all Azure Blob Storage tasks for consistency.
[1.5.0] - 2026-01-26
Added
Add options to support Arc Managed Identity authentication.
[1.4.0] - 2026-01-15
Changed
Updated Azure packages to the latest versions:
Azure.Storage.Blobs 12.27.0
Azure.Identity 1.17.1
[1.3.0] - 2025-12-12
Fixed
Fixed typo in error message.
[1.2.0] - 2024-08-21
Updated
Updated Azure.Identity to version 1.12.0.
Changed
Fixed outdated environment variable names in tests and workflows.
[1.1.1] - 2024-01-24
Updated
Azure.Identity to version 1.10.4
Azure.Storage.Blobs to version 12.19.1
[1.1.0] - 2022-12-20
Added
OAuth2 as a new additional authentication method.
New parameter 'Options.ThrowErrorIfBlobDoesNotExists' to choose if non existing blob throws an error or return an error as Result.Info.
Changed
New parameter 'Info' to result object.
Dependency update: Removed dependencies: System.ComponentModel.Annotations Azure.Core Azure.Storage.Common MimeMapping Microsoft.CSharp
Added dependencies: Azure.Identity 1.8.0
Update dependencies: Azure.Storage.Blobs 12.13.1 to 12.14.1
[1.0.1] - 2022-08-31
Changed
Security updated for dependency: Azure.Storage.Blobs 12.10.0 to 12.13.1 Also updated dependencies: Azure.Storage.Common 12.9.0 to 12.12.0 Azure.Core 1.20.0 to 1.25.0 System.ComponentModel.Annotations 4.7.0 to 5.0.0
[1.0.0] - 2022-03-07
Added
Initial implementation of Frends.AzureBlobStorage.DeleteBlob.
Last updated
Was this helpful?