# Azure Storage DataLake Service

{% hint style="info" %}
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
{% endhint %}

**Azure Storage Datalake Service** sends files to Azure DataLake Storage.

## **Parameters**

Take a look at the configuration options for the component. Parameters supported by [Double Braces expressions](https://docs.digibee.com/documentation/connectors-and-triggers/double-braces/overview) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>When active, the connector will use the account dynamically. Otherwise, it will use the account statically.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>The name of the dynamic account used by the connector. This account must have been previously configured in a <a href="../tools/store-account"><strong>Store Account</strong></a> connector in the pipeline for this process to take effect. It is only available if the <strong>Dynamic Account</strong> parameter is active.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>The account used by the connector. It is only available if the <strong>Dynamic Account</strong> parameter is inactive.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Fail On Error</strong></td><td>If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>Name of the Azure account.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File System Name</strong> <code>(DB)</code></td><td>Name of the filesystem to be used.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Client Id</strong> <code>(DB)</code></td><td>Client ID for the Azure account.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Close</strong></td><td>Whether or not a file changed event raised indicates completion (<code>true</code>) or modification (<code>false</code>).</td><td>false</td><td>Boolean</td></tr><tr><td><strong>Close Stream After Read</strong></td><td>Check for closing the stream after read.</td><td>false</td><td>Boolean</td></tr><tr><td><strong>Data Count</strong></td><td>Number of bytes to download.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Directory Name</strong> <code>(DB)</code></td><td>Directory of the file to be handled by the component.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Download Link Expiration</strong></td><td>Expiration time for the download link.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Expression</strong> <code>(DB)</code></td><td>Expression for <code>queryInputStream</code>.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File Dir</strong> <code>(DB)</code></td><td>Directory of the file for operations in the local system.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File Name</strong> <code>(DB)</code></td><td>Name of the file to be handled by the component.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File Offset</strong></td><td>Offset position in the file for different operations.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Max Results</strong></td><td>Maximum number of results to display at a time.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Max Retry Requests</strong></td><td>Number of retries for a given request.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Open Options</strong> <code>(DB)</code></td><td>Set open options for creating a file.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Path</strong> <code>(DB)</code></td><td>Path in Azure Data Lake for operations.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Permission</strong> <code>(DB)</code></td><td>Permission string for the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Position</strong></td><td>Allows the caller to upload data in parallel and control the order of appending it to the file.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Recursive</strong></td><td>Recursively include all paths.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Regex</strong> <code>(DB)</code></td><td>Regular expression for matching file names.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Retain Uncommitted Data</strong></td><td>Whether or not to retain uncommitted data after the operation.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Tenant Id</strong> <code>(DB)</code></td><td>Tenant ID for the Azure account.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Timeout</strong> <code>(DB)</code></td><td>Timeout for the operation.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Umask</strong> <code>(DB)</code></td><td>Umask permission for the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>User Principal Name Returned</strong></td><td>Whether or not to return the user principal name.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Operation</strong></td><td>Operation to be performed.</td><td><code>listFileSystem</code></td><td>String</td></tr></tbody></table>

### **Headers tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Operation</strong></td><td>Specify the producer operation to execute. Different allowed operations are shown below.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File System Name</strong> <code>(DB)</code></td><td>Name of the file system in Azure Data Lake where the operation will be performed. Ensure that the filesystem name is all lowercase.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Directory Name</strong> <code>(DB)</code></td><td>Name of the directory in Azure Data Lake where the operation will be performed.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File Name</strong> <code>(DB)</code></td><td>Name of the file in Azure Data Lake where the operation will be performed.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Metadata</strong></td><td>Metadata associated with the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Path</strong> <code>(DB)</code></td><td>Path of the file to be used for upload operations.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Recursive</strong></td><td>Specifies if the <code>listContainersSegment</code> call should recursively include all paths.</td><td>false</td><td>Boolean</td></tr><tr><td><strong>Max Results</strong></td><td>Maximum number of blobs to return, including all <code>BlobPrefix</code> elements.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>User Principal Name Returned</strong></td><td>Specifies if the name of the user principal should be returned.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Regex</strong> <code>(DB)</code></td><td>Filters results to return only files that match the specified regular expression.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File Dir</strong> <code>(DB)</code></td><td>Directory where the file will be downloaded.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Content MD5</strong> <code>(DB)</code></td><td>MD5 hash of the content, used to verify file integrity during transport.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Open Options</strong> <code>(DB)</code></td><td>Set of <code>OpenOption</code> used to configure file creation or opening.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Incremental Copy</strong></td><td>Indicates whether the file was incrementally copied.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Download Link Expiration</strong></td><td>Expiration time for the download link.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>File Offset</strong></td><td>Position where the data will be appended.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Lease Id</strong> <code>(DB)</code></td><td>Requests will fail if the provided lease does not match the active lease on the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Retain Committed Data</strong></td><td>Determines whether or not to retain uncommitted data after the operation.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Close</strong></td><td>Whether a file changed event indicates completion (<code>true</code>) or modification (<code>false</code>).</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Position</strong></td><td>Length of the file after all data has been written.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Expression</strong> <code>(DB)</code></td><td>Query expression on the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Permission</strong> <code>(DB)</code></td><td>Sets the permission for the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Umask</strong> <code>(DB)</code></td><td>Sets the umask for the file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Flush</strong></td><td>Indicates whether to flush on append.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>