# DeleteFiles

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.AzureDataLake/tree/main/Frends.AzureDataLake.DeleteFiles>

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

| Name                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ConnectionMethod : `ConnectionMethod` | <p>Which connection method should be used for connecting to Azure Data Lake.</p><p>Possible values:</p><ul><li><code>ConnectionString</code>:</li></ul><p>Which connection method should be used for connecting to Azure Data Lake.</p><ul><li><code>OAuth2</code>:</li></ul><p>Which connection method should be used for connecting to Azure Data Lake.</p><p><br>Default: <code>1</code><br>Example: <code>ConnectionMethod.ConnectionString</code></p> |
| 🗝ConnectionString : `String`         | <p>Connection string to Azure Data Lake.</p><p><br>Default: <code>-</code><br>Example: <code>DefaultEndpointsProtocol=https;AccountName=accountname;AccountKey=Pdlrxyz==;EndpointSuffix=core.windows.net</code></p>                                                                                                                                                                                                                                        |
| StorageAccountName : `String`         | <p>Name of the Azure Data Lake account.</p><p><br>Default: <code>-</code><br>Example: <code>storager</code></p>                                                                                                                                                                                                                                                                                                                                            |
| ApplicationID : `String`              | <p>Application (Client) ID of Azure AD Application.</p><p><br>Default: <code>-</code><br>Example: <code>Y6b1hf2a-80e2-xyz2-qwer3h-3a7c3a8as4b7f</code></p>                                                                                                                                                                                                                                                                                                 |
| TenantID : `String`                   | <p>Tenant ID of Azure Tenant.</p><p><br>Default: <code>-</code><br>Example: <code>Y6b1hf2a-80e2-xyz2-qwer3h-3a7c3a8as4b7f</code></p>                                                                                                                                                                                                                                                                                                                       |
| 🗝ClientSecret : `String`             | <p>Client Secret of Azure AD Application.</p><p><br>Default: <code>-</code><br>Example: <code>Password!</code></p>                                                                                                                                                                                                                                                                                                                                         |
| ContainerName : `String`              | <p>Name of the Azure Data Lake 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>                                                                                                                                                                                  |
| DeleteFilePattern : `String`          | <p>Path of file(s) you want to delete from DataLake</p><p>This parameter can contain a combination of valid literal path and wildcard (\* and ?) characters, but it doesn't support regular expressions.</p><p><br>Default: <code>-</code><br>Example: <code>file?.txt</code></p>                                                                                                                                                                          |
| {% endtab %}                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

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

| Name                            | Description                                                                                                                                                                                        |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ThrowErrorOnFailure : `Boolean` | <p>True: Throw an exception.</p><p>False: Return Result with IsSucces=false and ErrorMessage with description of exception.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p> |
| {% endtab %}                    |                                                                                                                                                                                                    |

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

| Name                          | Description                                                                                                                                                                                                            |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| IsSuccess : `Boolean`         | <p>Operation complete. Operation is seens as completed if all desired files were deleted.<br>Example: <code>true</code></p>                                                                                            |
| DeletedFiles : `List<String>` | <p>This object contains list of deleted filesą<br>Example: <code>{ <https://storage.blob.core.windows.net/container/examplefile.txt>, <https://storage.blob.core.windows.net/container/examplefile2.txt>, }</code></p> |
| ErrorMessage : `String`       | <p>This object contains the error message if task fails.<br>Example: <code>Container ex does not exist</code></p>                                                                                                      |
| {% endtab %}                  |                                                                                                                                                                                                                        |

{% tab title="Changelog" %}

## Changelog

### \[1.2.0] - 2026-01-15

#### Changed

* Updated Azure packages to latest versions:
* Azure.Storage.Files.DataLake 12.25.0
* Azure.Identity 1.17.1

### \[1.1.0] - 2024-08-23

#### Changed

* Updated the Azure.Identity package to version 1.12.0.

### \[1.0.0] - 2024-05-21

#### Added

* Initial implementation of Frends.AzureDataLake.DeleteFiles.
  {% endtab %}
  {% endtabs %}
