# DeleteBlob

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.AzureBlobStorage/tree/main/Frends.AzureBlobStorage.DeleteBlob>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                     | Description                                                                                                                                                                                                                                                                  |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ContainerName : `String` | <p>Name of the Azure Blob Storage container where the data will be uploaded.</p><p>Naming: lowercase</p><p>Valid chars: alphanumeric and dash, but cannot start or end with dash.</p><p><br>Default: <code>test-container</code><br>Example: <code>test-container</code></p> |
| BlobName : `String`      | <p>Name of the blob to delete.</p><p><br>Default: <code>-</code><br>Example: <code>TestFile.xml</code></p>                                                                                                                                                                   |
| {% endtab %}             |                                                                                                                                                                                                                                                                              |

{% tab title="Parameter: Connection" %}

| Name                                      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AuthenticationMethod : `ConnectionMethod` | <p>Defines which connection method should be used for connecting to Azure Blob Storage.</p><p>Possible values:</p><ul><li><code>ConnectionString</code>:</li></ul><p>Defines which connection method should be used for connecting to Azure Blob Storage.</p><ul><li><code>OAuth2</code>:</li></ul><p>Defines which connection method should be used for connecting to Azure Blob Storage.</p><ul><li><code>SasToken</code>:</li></ul><p>Defines which connection method should be used for connecting to Azure Blob Storage.</p><ul><li><code>ArcManagedIdentity</code>:</li></ul><p>Defines which connection method should be used for connecting to Azure Blob Storage.</p><ul><li><code>ArcManagedIdentityCrossTenant</code>:</li></ul><p>Defines which connection method should be used for connecting to Azure Blob Storage.</p><p><br>Default: <code>1</code><br>Example: <code>ConnectionMethod.ConnectionString</code></p> |
| 🗝ConnectionString : `String`             | <p>Connection string to Azure storage.</p><p><br>Default: <code>-</code><br>Example: <code>DefaultEndpointsProtocol=https;AccountName=account-name;AccountKey=abc==;EndpointSuffix=core.windows.net</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ApplicationId : `String`                  | <p>Application (Client) ID of Azure AD Application.</p><p><br>Default: <code>-</code><br>Example: <code>Y6b1hf2a-80e2-xyz2-abc33h-3a7c3a8as4b7f</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| TenantId : `String`                       | <p>Tenant ID of Azure Tenant.</p><p><br>Default: <code>-</code><br>Example: <code>Y6b1hf2a-80e2-xyz2-abc33h-3a7c3a8as4b7f</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| 🗝ClientSecret : `String`                 | <p>Client Secret of Azure AD Application.</p><p><br>Default: <code>-</code><br>Example: <code>Password!</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| 🗝SasToken : `String`                     | <p>A shared access signature to use when connecting to an Azure storage container.</p><p>Grants restricted access rights to Azure Storage resources when combined with URI.</p><p><br>Default: <code>-</code><br>Example: <code>sv=2021-04-10\&se=2022-04-10T10%3A431Z\&sr=c\&sp=l\&sig=ZJg983RovE%23ZXI</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| StorageAccountName : `String`             | <p>Name of the Azure storage account.</p><p><br>Default: <code>-</code><br>Example: <code>TestStorage</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Scopes : `String[]`                       | <p>Scopes used when authenticating with Arc Managed Identity Cross Tenant.</p><p><br>Default: <code>-</code><br>Example: <code>\[api://AzureADTokenExchange/.default]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| TargetTenantId : `String`                 | <p>Target Tenant ID of Azure Tenant.</p><p><br>Default: <code>-</code><br>Example: <code>Y6b1hf2a-80e2-xyz2-abc33h-3a7c3a8as4b7f</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| TargetClientId : `String`                 | <p>Target Client ID of Azure Tenant.</p><p><br>Default: <code>-</code><br>Example: <code>Y6b1hf2a-80e2-xyz2-abc33h-3a7c3a8as4b7f</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| {% endtab %}                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

{% tab title="Parameter: Options" %}

| Name                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                            |
| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SnapshotDeleteOption : `SnapshotDeleteOption` | <p>What should be done with blob snapshots?</p><p>Possible values:</p><ul><li><code>None</code>:</li></ul><p>What should be done with blob snapshots?</p><ul><li><code>IncludeSnapshots</code>:</li></ul><p>What should be done with blob snapshots?</p><ul><li><code>DeleteSnapshotsOnly</code>:</li></ul><p>What should be done with blob snapshots?</p><p><br>Default: <code>1</code><br>Example: <code>IncludeSnapshots</code></p> |
| VerifyETagWhenDeleting : `String`             | <p>Delete blob only if the ETag matches. Leave empty if verification is not needed.</p><p><br>Default: <code>-</code><br>Example: <code>0x9FE13BAA323E5A4</code></p>                                                                                                                                                                                                                                                                   |
| ThrowErrorIfBlobDoesNotExists : `Boolean`     | <p>If true, throw an error if blob to be deleted doesn't exist.</p><p>If false, Task will return Success = true.</p><p><br>Default: <code>False</code><br>Example: <code>false</code></p>                                                                                                                                                                                                                                              |
| {% endtab %}                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                        |

{% tab title="Result: Result" %}

| Name                | Description                                                                                                   |
| ------------------- | ------------------------------------------------------------------------------------------------------------- |
| Success : `Boolean` | <p>Returns true if the blob has been deleted.<br>Example: <code>true</code></p>                               |
| Info : `String`     | <p>Additional information.<br>Example: <code>Blob file.txt deleted from container test-container."</code></p> |
| {% endtab %}        |                                                                                                               |

{% tab title="Changelog" %}

## Changelog

### \[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.
  {% endtab %}
  {% endtabs %}
