> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/azure-data-lake/downloadfiles.md).

# DownloadFiles

Task version: 1.2.0

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.DownloadFiles>

## Task Parameters

{% tabs %}
{% tab title="Source" %}

| 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>: Which connection method should be used for connecting to Azure Data Lake.</li><li><code>OAuth2</code>: Which connection method should be used for connecting to Azure Data Lake.</li></ul><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>storageexample</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>                                                                                                                                                             |
| FilePattern : `String`                | <p>Path of file(s) you want to download 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: <em><code>.txt</code></em><br><em>Example:</em> <code>.txt</code></p>                                                                                                                                    |
| {% endtab %}                          |                                                                                                                                                                                                                                                                                                                                                                                                                                       |

{% tab title="Destination" %}

| Name                  | Description                                                                                                       |
| --------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Directory : `String`  | <p>Destination directory.</p><p><br>Default: <code>-</code><br>Example: <code>c:\temp</code></p>                  |
| Overwrite : `Boolean` | <p>How the existing file will be handled.</p><p><br>Default: <code>False</code><br>Example: <code>true</code></p> |
| {% endtab %}          |                                                                                                                   |

{% tab title="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 %}                    |                                                                                                                                                                                                    |
| {% endtabs %}                   |                                                                                                                                                                                                    |

## Task Result

| Name                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| IsSuccess : `Boolean`                         | <p>Operation complete. Operation is seens as completed if all desired files was downloaded.<br>Example: <code>true</code></p>                                                                                                                                                                                                                                                                                    |
| DownladedFiles : `Dictionary<String, String>` | <p>This object contains the source file URL as a key and the path of the downloaded file as a value. If overwrite is disabled, error message will be placed as a value<br>Example: <code>{ {<https://storage.blob.core.windows.net/container/examplefile.txt>, c:\temp\examplefile.txt }, { <https://storage.blob.core.windows.net/container/examplefile2.txt>, File examplefile2 already exists. } }</code></p> |
| ErrorMessage : `String`                       | <p>This object contains the error message if task fails.<br>Example: <code>Container ex does not exist</code></p>                                                                                                                                                                                                                                                                                                |

## Task Changelog

Changelog for Task Frends.AzureDataLake.DownloadFiles.

### \[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-17

#### Added

* Initial implementation of Frends.AzureDataLake.DownloadFiles.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.frends.com/tasks/tasks/azure-data-lake/downloadfiles.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
