# mulesoft Azure Data Lake Storage Connector - Full Documentation --- product: Azure Data Lake Storage Connector version: 1.0 is-latest-version: true --- # Azure Data Lake Storage - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. When you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/azure-data-lake-storage http://www.mulesoft.org/schema/mule/azure-data-lake-storage/current/azure-data-lake-storage.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml

``` ## Create a Path This example shows you how to create a path in Azure Data Lake Storage and includes the following steps: 1. [Set up the app flow](#set-up-create-path-flow). 2. [Configure the Create Path operation](#configure-create-path). 3. [Optionally, copy and paste the XML](#create-path-xml) for the flow in to the **Configuration XML** tab. ### Set Up the App Flow Follow these steps to create and configure an HTTP **Listener** source to initiate the flow each time it receives a request on the configured host and port: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation: 3. Drag the **Listener** operation onto the Studio canvas. 4. In the **Listener** configuration, click **+** next to the **Connector configuration** field to add a global element. 5. Accept the defaults and click **OK**. 6. In the **General** properties tab, set the **Path** field to `create-path`: ![HTTP Listener General properties tab](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-create-path-setting-up-the-flow-2.png) ### Configure the Create Path operation Follow these steps to create a file or directory on the provided Azure Data Lake Storage file system: 1. In the **Mule Palette** view, search for `azure` and select the **Create/Rename Path** operation. 2. Drag the **Create/Rename Path** operation from the Studio canvas onto the **Listener** flow. 3. In the **Create/Rename Path** configuration, click **+** next to the **Connector Configuration** field to add a connection configuration. 4. On the **General** tab, in **Connection**, select the authentication method to configure and enter all the required values: ![Create File System Config with Shared Access Signature connection values](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-create-file-system-filling-values-1.png) 5. Click **OK**. 6. In the **File System** field, enter the value for your target Azure Data Lake Storage file system. If the file system does not exist, an error is thrown. 7. In **Path**, enter your desired path name. 8. In **Resource**, enter either `file` or `directory`: ![General properties configuration for Create/Rename Path operation](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-create-path-filling-values.png) 9. Save the project. 10. Test the app by sending a GET request to `localhost:8081/create-path`. ### XML for Creating a Path Paste this code into the **Configuration XML** tab of your flow to quickly load the flow for this example into your Mule app: ```xml

``` ## Configure Update Path Operations with Append and Flush In this example, you configure two **Update Path** operations: - The first **Update Path** operation is configured with **append** to append contents to an existing file on the Azure Data Lake Storage file system. To do this, you first set up the app flow, add the File Connector **Read** operation, configure the **Set Variable** component, then configure the **Update Path** operation with **append**. - The second **Update Path** operation is then configured with **flush** to flush the contents of an existing file on the Azure Data Lake Storage file system. ### Set Up the App Flow Follow these steps to create and configure an HTTP **Listener** source to initiate the flow each time it receives a request on the configured host and port: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation: 3. Drag the **Listener** operation onto the Studio canvas. 4. In the **Listener** configuration, click **+** next to the **Connector configuration** field to add a global element. 5. Accept the defaults and click **OK**. 6. In the **General** properties tab, set the **Path** field to `update-path`: ![Listener General properties configuration](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-update-path-setting-up-the-flow-2.png) ### Add and Configure File Connector Add File Connector to your project and configure the **Read** operation to read files on the Azure Data Lake Storage file system: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `file connector` in the search field. 3. Click **File Connector** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. ![File Connector added from Exchange to your flow](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-update-path-adding-file-connector.png) 6. In the **Mule Palette** view, select **File > Read** and drag the **Read** operation onto the flow. 7. In **General** properties tab for the **Read** operation, click **+** next to the **Connector Configuration** field to add a connection configuration. 8. Enter the values and click **OK**. 9. In the **General** properties for the **Read** operation, enter the absolute path to the file upload in **File Path**: ![Read operation General properties configuration](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-update-path-using-the-file-connector-2.png) ### Configure the Set Variable Component Configure a **Set Variable** component to store and use a variable later in the flow: 1. From the **Mule Palette** view, search for `set variable` and drag **Set Variable** next to the **Read** operation on the Studio canvas. 2. In the **General** properties tab, enter these values: - **Name** `fileSize` - **Value** `#[attributes.size]`\+ This saves the length of the file variable for the next operations. ![General properties configuration for the Set Variable component](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-update-path-using-the-file-connector-3.png) ### Configure the Update Path Operation with Append Configure the **Update Path** operation to add **append** so you can append contents to a file: 1. In the **Mule Palette** view, search for `azure` and select the Azure Data Lake Storage Connector **Update Path** operation. 2. Drag the **Update Path** operation from the **Mule Palette** view onto the **Listener** flow, next to the **Set Variable** component. 3. In the **General** configuration properties pane of **Update Path**, select the connection configuration for the operation. 4. In the **General** properties tab, enter the following values: - **File System** Value for your target Azure Data Lake Storage file system - **Path** Value for your target path - **Action** `append` - **Position** `0` - **Content Length** `#[vars.fileSize]` - **Content** `payload` ![General configuration properties with example values for the Update Path operation with append](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-update-path-using-update-append.png) 5. Save the project. ### Configure the Update Path Operation with Flush Configure the **Update Path** operation to add **flush** so you can flush the contents of a file: 1. In the **Mule Palette** view, search for `azure` and select the Azure Data Lake Storage Connector **Update Path** operation. 2. Drag the **Update Path** operation from the Studio canvas onto the **Listener** flow, next to the **Update Path** operation that you created in [the step for append](#update-path-append). 3. In the **General** configuration properties pane of **Update Path**, select the connection configuration for the operation. 4. In the **General** properties tab, enter the following values: - **File System** Your target Azure Data Lake Storage file system - **Path** Your target path - **Action** `flush` - **Position** `#[vars.fileSize]` - **Content Length** `0` ![General configuration properties with example values for the Update Path operation with flush](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-update-path-using-update-flush.png) 5. Save the project. 6. Open a browser and send a GET request to `localhost:8081/update-path` to test the app. ### XML for Updating a Path Paste this code into the **Configuration XML** tab of your flow to quickly load the flow for this example into your Mule app: ```xml

``` ## Implement Error Handling This section shows you how to implement simple error handling on a flow that uses Azure Data Lake Storage Connector. 1. In any flow, from the **Mule Palette** view, select **Core > On Error Continue** and drag it to the **Error Handling** section of the flow: ![On Error Continue component dragged to the flow](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-error-handling-setting-up-1.png) 2. From the **Mule Palette** view, drag **Core > Transform Message** to the flow: ![Transform Message component dragged to the flow](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-error-handling-setting-up-2.png) 3. In the **Mule Palette** view, search for `logger` and drag the **Logger** component to the right of **Transform Message**. 4. In the **General** properties tab for the **Logger** component, enter the following values: output application/json --- error.errorMessage.payload To access the error code that comes from the Azure service, the expression is: `error.muleMessage.typedValue.error.code` ![Expression to access the error code that comes from the Azure service](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-error-handling-setting-up-3.png) To access the error message, the expression is: `error.muleMessage.typedValue.error.message` ![Expression to access the error message](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-error-handling-setting-up-4.png) ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Azure Data Lake Storage Connector version: 1.0 is-latest-version: true --- # Azure Data Lake Storage Connector Module Connector Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations ### Parameters

Name	Type	Description	Default Value	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	OAuth 2.0 Connection Provider Shared Access Signature Shared Key Connection	The connection types that can be provided to this configuration.		x
Response Timeout	Number	The timeout for requests to the remote service.	1
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout	MINUTES
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to `AUTO` will automatically define the best strategy based on the request content.	AUTO
Name	String	The identifier of this element used in other components to reference it		x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

## Connection Types ### OAuth 2.0 Connection Provider Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters

Name	Type	Description	Default Value	Required
Default Headers	Array of Default Header
Query Parameters	Array of Default Query Param
Connection Timeout	Number	The timeout for establishing connections to the remote service	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout	SECONDS
Use Persistent Connections	Boolean	If false, each connection is closed after the first request is completed.	true
Max Connections	Number	The maximum number of outbound connections that to keep open at the same time	-1
Connection Idle Timeout	Number	A timeout for how long a connection can remain idle before it is closed	30
Connection Idle Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the connection Idle Timeout	SECONDS
Proxy Config	Proxy	Reusable configuration element for outbound connections through a proxy
Stream Response	Boolean	Whether or not received responses should be streamed	false
Response Buffer Size	Number	The space in bytes for the buffer where the HTTP response will be stored.	-1
Base URI	String	Parameter base URI, each instance/tenant gets its own		x
X-MS-Version	String	Specifies the version of the REST API protocol used for processing the request	2018-11-09
TLS Configuration	TLS
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

### Shared Access Signature #### Parameters

Name	Type	Description	Default Value	Required
Default Headers	Array of Default Header
Query Parameters	Array of Default Query Param
Connection Timeout	Number	The timeout for establishing connections to the remote service	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout	SECONDS
Use Persistent Connections	Boolean	If false, each connection will be closed after the first request is completed.	true
Max Connections	Number	The maximum number of outbound connections that will be kept open at the same time	-1
Connection Idle Timeout	Number	A timeout for how long a connection can remain idle before it is closed	30
Connection Idle Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit that qualifies the connection Idle Timeout	SECONDS
Proxy Config	Proxy	Reusable configuration element for outbound connections through a proxy
Stream Response	Boolean	Whether or not to stream received responses	false
Response Buffer Size	Number	The space in bytes for the buffer where the HTTP response is stored.	-1
Storage account name	String	Storage account name		x
DNS Suffix	String	DNS suffix of the storage. The DNS suffix works only with `dfs.core.windows.net`.		x
Sas Token	String	SAS token for the Azure Data Lake Storage account.		x
TLS Configuration	TLS
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

### Shared Key Connection #### Parameters

Name	Type	Description	Default Value	Required
Default Headers	Array of Default Header
Query Parameters	Array of Default Query Param
Connection Timeout	Number	The timeout for establishing connections to the remote service	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout	SECONDS
Use Persistent Connections	Boolean	If false, each connection is closed after the first request is completed.	true
Max Connections	Number	The maximum number of outbound connections to keep open concurrently	-1
Connection Idle Timeout	Number	A timeout for how long a connection can remain idle before it is closed	30
Connection Idle Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the connection Idle Timeout	SECONDS
Proxy Config	Proxy	Reusable configuration element for outbound connections through a proxy
Stream Response	Boolean	Whether or not to stream received responses	false
Response Buffer Size	Number	The space in bytes for the buffer where the HTTP response is stored.	-1
Storage account name	String	Storage account name		x
DNS Suffix	String	DNS suffix of the storage. The DNS suffix works only with `dfs.core.windows.net`.		x
X-MS-Version	String	Specifies the version of the REST protocol used for processing the request		x
Account Key	String	Password used to access the Azure Data Lake Storage account.		x
TLS Configuration	TLS
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## List of Supported Operations - [Create File System](#CreateFileSystem) - [Create/Rename Path](#CreateOrRename) - [Delete File System](#DeleteFileSystem) - [Delete Path](#DeletePath) - [Get Path Properties](#GetPathProperties) - [Lease path](#LeasePath) - [List File Systems](#ListFileSystems) - [List Paths](#ListPaths) - [Read Path](#ReadPath) - [Update Path](#UpdatePath) ## Create File System `` Creates a file system on the storage account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
File System	String	Target file system.		x
Timeout	Number	Optional. Timeout value expressed in seconds.
X-MS-Properties	String	User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, `n1=v1, n2=v2, …`, where each value is a Base64-encoded string.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to `AUTO` will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target Variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	String
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## Create/Rename Path `` Creates or renames a file or directory path on the provided file system. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
File System	String	Target file system.		x
Path	String	Target path.		x
Resource	String	Only required for creation. The value must be `file` or `directory`.
Continuation	String	Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited.
Mode	String	Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be `legacy` or `posix`, and the default value is `posix`.
X-MS-Rename Source	String	An optional file or directory to rename. The value must have the following format:`/{filesystem}/{path}`. If `x-ms-properties` is specified it overwrites the existing properties; otherwise, the existing properties are preserved. This value must be a URL percent-encoded string and the string can contain only ASCII characters in the ISO-8859-1 format.
Timeout	Number	Optional. Timeout value expressed in seconds.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Cache Control	String	The service stores this value and includes it in the "Cache-Control" response header for `Read Path` operations.
Content Encoding	String	Specifies which content encodings are applied to the file. This value is returned to the client when the `Read Path` operation is performed.
Content Language	String	Optional. Specifies the natural language used by the intended audience for the file.
Content Disposition	String	The service stores this value and includes it in the "Content-Disposition" response header for `Read Path` operations.
X-MS-Cache Control	String	The service stores this value and includes it in the "Cache-Control" response header for `Read Path` operations.
X-MS-Content Type	String	The service stores this value and includes it in the "Content-Type" response header for `Read Path` operations.
X-MS-Content Encoding	String	The service stores this value and includes it in the "Content-Encoding" response header for `Read Path` operations.
X-MS-Content Language	String	The service stores this value and includes it in the "Content-Language" response header for `Read Path` operations.
X-MS-Content Disposition	String	The service stores this value and includes it in the "Content-Disposition" response header for `Read Path` operations.
X-MS-Lease ID	String	A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match.
X-MS-Source Lease ID	String	Optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match.
X-MS-Properties	String	User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, `n1=v1, n2=v2, …`, where each value is a Base64-encoded string.
X-MS-Permissions	String	Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others.
X-MS-Umask	String	Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory, if the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created.
If Match	String	An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes.
If None Match	String	An ETag value or the special wildcard (`*`) value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes.
If Modified Since	String	A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
X-MS-Source If Match	String	An ETag value. Specify this header to perform the rename operation only if the source’s ETag matches the value specified. The ETag must be specified in quotes.
X-MS-Source If None Match	String	An ETag value or the special wildcard (`*`) value. Specify this header to perform the rename operation only if the source’s ETag does not match the value specified. The ETag must be specified in quotes.
X-MS-Source If Modified Since	String	A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.
X-MS-Source If Unmodified Since	String	A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout.
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	String
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## Delete File System `` Deletes a file system on the Storage account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
File System	String	Target file system.		x
Timeout	Number	Optional. Timeout value expressed in seconds.
If Modified Since	String	Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
X-MS-Properties	String	User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, `n1=v1, n2=v2, …`, where each value is a Base64-encoded string.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout.
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	String
Attributes Type	HTTP Response Attributes

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
File System	String	Target file system.		x
Path	String	Target path.		x
Continuation	String	When deleting a directory, the number of paths that are deleted with each invocation is limited.
Recursive	String	Required for directory only. If `true`, all paths beneath the directory are deleted. If `false` and the directory is non-empty, an error occurs.
Timeout	Number	Optional. Timeout value expressed in seconds.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
X-MS-Lease ID	String	A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match.
If Match	String	An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes.
If None Match	String	An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes.
If Modified Since	String	A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout.
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	String
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## Get Path Properties `` Retrieves the properties of a path. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
File System	String	Target file system.		x
Path	String	Target path.		x
Action	String	Optional. If the value is `getStatus`, only the system-defined properties for the path are returned. If the value is `getAccessControl`, the access control list is returned in the response headers if Hierarchical Namespace is enabled for the account, otherwise, the properties are returned.
Timeout	Number	Optional. Timeout value expressed in seconds.
UPN	Boolean	Optional. Valid only when Hierarchical Namespace is enabled for the account. If `true`, the user identity values returned in the Owner and Group fields of each list entry are transformed from Azure Active Directory Object IDs to User Principal Names. If `false`, the values are returned as Azure Active Directory Object IDs. The default value is `false`. Group and application Object IDs are not translated because they do not have unique friendly names.	false
X-MS-Lease ID	String	A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match.
If Match	String	An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes.
If None Match	String	An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes.
If Modified Since	String	Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout.
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	String
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## Lease path `` Create and manage a lease to restrict write and delete access to the path. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
File System	String	Target file system.		x
Path	String	Target path.		x
X-MS-Lease Action	String	The lease action, which can be: `acquire`, `break`, `change`, `renew`, and `release`.		x
X-MS-Lease ID	String	Required when "x-ms-lease-action" is `renew`, `change`, or `release`. For the `renew` and `release` actions, this must match the current lease ID.
X-MS-Lease Duration	Number	The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for an infinite lease.
X-MS-Proposed Lease ID	String	Required when "X-MS-Lease Action" is `acquire` or `change`. A lease will be acquired with this lease ID if the operation is successful.
Timeout	Number	Optional. Timeout value expressed in seconds.
X-MS-Lease Break Period	Number	Optional. Breaks a lease, and specifies the break period duration of the lease in seconds. The lease break duration must be between 0 and 60 seconds.
If Match	String	Optional. An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes.
If None Match	String	Optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes.
If Modified Since	String	Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In-Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## List File Systems `` Lists all the file systems on the account. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Continuation	String	Number of file systems returned with each invocation is limited. If the number of file systems to return exceeds this limit, a continuation token is returned in the response header x-ms-continuation.
Max Results	Number	An optional value that specifies the maximum number of items to return. If omitted, or greater than 5,000, the response will include up to 5,000 items.
Prefix	String	Filters results to file systems within the specified prefix.
Timeout	Number	Optional. Timeout value expressed in seconds.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In-Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	Timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## List Paths `` List all paths of a file system. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
File System	String	Target file system.		x
Recursive	Boolean	If `true`, all paths are listed; otherwise, only paths at the root of the file system are listed. If `directory` is specified, the list only includes paths that share the same root.	false
Continuation	String	The number of paths returned with each invocation is limited. If the number of paths to return exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.
Directory	String	Filters results to paths within the specified directory. An error occurs if the directory does not exist.
Max Results	Number	An optional value that specifies the maximum number of items to return. If omitted, or greater than 5,000, the response will include up to 5,000 items.
Timeout	Number	Optional. Timeout value expressed in seconds.
UPN	Boolean	Optional. Valid only when Hierarchical Namespace is enabled for the account. If `true`, the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If `false`, the values are returned as Azure Active Directory Object IDs. The default value is `false`. Group and application Object IDs are not translated because they do not have unique friendly names.	false
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Streaming Strategy	Repeatable In-Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## Read Path `` Read the contents of a file. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
File System	String	Target file system.		x
Path	String	Target path.		x
Range	String	The HTTP range request header specifies one or more byte ranges of the resource to be retrieved.
Timeout	Number	Optional. Timeout value expressed in seconds.
X-MS-Lease ID	String	A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match.
X-MS-Range Get Content MD5	String	Optional. When this header is set to `true` and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size.
If Match	String	An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes.
If None Match	String	An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes.
If Modified Since	String	A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In-Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Custom Query Parameters	Object		#[null]
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines whether to send the request using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	HTTP Response Attributes

### For Configurations - [Configurations](#configurations) ### Throws - AZURE-DATA-LAKE-STORAGE:BAD\_REQUEST - AZURE-DATA-LAKE-STORAGE:CLIENT\_ERROR - AZURE-DATA-LAKE-STORAGE:CONNECTIVITY - AZURE-DATA-LAKE-STORAGE:INTERNAL\_SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:NOT\_ACCEPTABLE - AZURE-DATA-LAKE-STORAGE:NOT\_FOUND - AZURE-DATA-LAKE-STORAGE:RETRY\_EXHAUSTED - AZURE-DATA-LAKE-STORAGE:SERVER\_ERROR - AZURE-DATA-LAKE-STORAGE:SERVICE\_UNAVAILABLE - AZURE-DATA-LAKE-STORAGE:TIMEOUT - AZURE-DATA-LAKE-STORAGE:TOO\_MANY\_REQUESTS - AZURE-DATA-LAKE-STORAGE:UNAUTHORIZED - AZURE-DATA-LAKE-STORAGE:UNSUPPORTED\_MEDIA\_TYPE ## Update Path `` Uploads data to append to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
File System	String	Target file system.		x
Path	String	Target path.		x
Action	String	Action to perform, must be `append` or `flush`.		x
Position	Number	Allows the caller to upload data in parallel and control the order in which it is appended to the file.	0
Content Length	Number	Required for Append or Flush data. Must be `0` for Flush. Must be the length of the request content in bytes for Append.		x
Content	Binary	The payload to upload.	#[payload]
Timeout	Number	Optional. Timeout value expressed in seconds.
Close	String	Allow applications to receive notifications when files change.
Retain Uncommitted Data	Boolean	Valid for flush operations. If true, uncommitted data is retained after the flush operation completes. Defaults to false.	false
Content MD5	String	An MD5 hash of the request content. This header is valid on `Append` and `Flush` operations.
X-MS-Lease ID	String	A lease ID for the path specified in the URI. The path to overwrite must have an active lease and the lease ID must match.
X-MS-Cache Control	String	The service stores this value and includes it in the "Cache-Control" response header for `Read Path` operations.
X-MS-Content Type	String	The service stores this value and includes it in the "Content-Type" response header for `Read Path` operations.
X-MS-Content Encoding	String	The service stores this value and includes it in the "Content-Encoding" response header for `Read Path` operations.
X-MS-Content Language	String	The service stores this value and includes it in the "Content-Language" response header for `Read Path` operations.
X-MS-Content Disposition	String	The service stores this value and includes it in the "Content-Disposition" response header for `Read Path` operations.
X-MS-Content MD5	String	Optional and only valid for Flush & Set Properties operations. The service stores this value and includes it in the "Content-Md5" response header for Read & Get Properties operations.
X-MS-Properties	String	User-defined properties to store with the file or directory, in the format of a comma-separated list of name and value pairs, for example, `n1=v1, n2=v2, …`, where each value is a Base64-encoded string.
X-MS-Permissions	String	Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others.
X-MS-Owner	String	Optional and valid only for the setAccessControl Operation. Sets the owner of the file or directory.
X-MS-Group	String	Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory.
X-MS-ACL	String	Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories.
If Match	String	An ETag value. Specify this header to perform the operation only if the resource’s ETag matches the value specified. The ETag must be specified in quotes.
If None Match	String	An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource’s ETag does not match the value specified. The ETag must be specified in quotes.
If Modified Since	String	A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.
If Unmodified Since	String	A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
X-MS-Client Request ID	String	A UUID recorded in the analytics logs for troubleshooting and correlation.
Config Ref	ConfigurationProvider	The name of the configuration to be used to execute this component		x
Streaming Strategy	Repeatable In-Memory Stream Repeatable File Store Stream Non-Repeatable Stream	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Custom Query Parameters	Object
Custom Headers	Object
Response Timeout	Number	The timeout for requests to the remote service.
Response Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Response Timeout
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	String	Name of the variable in which to store the operation’s output.
Target Value	String	An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.	#[payload]
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

### Output

Type	Any
Attributes Type	HTTP Response Attributes

Field	Type	Description	Default Value	Required
Key	String			x
Value	String			x

### Default Query Param

Field	Type	Description	Default Value	Required
Key	String			x
Value	String			x

### Proxy

Field	Type	Required
Host	String	x
Port	Number	x
Username	String
Password	String
Non Proxy Hosts	String

### TLS

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma-separated list of cipher suites enabled for this context.
Trust Store	Trust Store
Key Store	Key Store
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File

### Trust Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.
Password	String	The password used to protect the truststore.
Type	String	The type of truststore used.
Algorithm	String	The algorithm used by the truststore.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.
Type	String	The type of keystore used.
Alias	String	When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the keystore.
Algorithm	String	The algorithm used by the keystore.

### Standard Revocation Check

Field	Type	Description
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer Crls	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

### Custom OCSP Responder

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### CRL File

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

### Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use

### Reconnect

Field	Type	Description
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread
Count	Number	How many reconnection attempts to make

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often (in ms) to reconnect
Blocking	Boolean	If false, the reconnection strategy will run in a separate, non-blocking thread

### Expiration Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the maxIdleTime attribute

### HTTP Response Attributes

Field	Type	Required
Status Code	Number	x
Headers	Object	x
Reason Phrase	String	x

### Repeatable In-Memory Stream When streaming in this mode, Mule does not use the disk to buffer the contents. If you exceed the buffer size, the message fails.

Field	Type	Description
Initial Buffer Size	Number	This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than what can fit into this buffer, then it expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.
Buffer Size Increment	Number	This specifies the increment for how much the buffer size will expand if it exceeds its initial specified size. Setting a value of zero or lower means that the buffer should not expand, and a `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised when the buffer gets full.
Max Buffer Size	Number	This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which all these attributes are expressed

### Repeatable File Store Stream File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field	Type	Description	Default Value	Required
In Memory Size	Number	Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which maxInMemorySize is expressed

### Non-Repeatable Stream Disables the repeatable stream functionality and use non-repeatable streams to have less performance overhead, memory use, and cost. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Azure Data Lake Storage Connector version: 1.0 is-latest-version: true --- # Using Anypoint Studio to Configure Azure Data Lake Storage Connector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Azure Data Lake Storage Connector Reference](https://docs.mulesoft.com/azure-data-lake-storage-connector/latest/azure-data-lake-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Azure Data Lake Storage Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `azure data lake storage` in the search field. 3. Click Azure Data Lake Storage in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Azure Data Lake Storage Connector: - **HTTP > Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of HTTP **Listener** in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Azure Data Lake Storage Connector, follow these steps: 1. In the **Mule Palette** view, select **Azure Data Lake Storage** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Azure Data Lake Storage system. Azure Data Lake Storage Connector supports Azure Active Directory OAuth 2.0, Shared Access Signature, and Shared Key Connection authentication methods. To configure the global element for Azure Data Lake Storage Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - **OAuth 2.0 Connection Provider** (Azure Active Directory OAuth 2.0) - **Shared Access Signature** - **Shared Key Connection** You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth 2.0 Connection Provider Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Azure Active Directory OAuth 2.0 authentication: - **Base URI** One per instance or tenant - **X-MS Version** Version of the REST API protocol used for processing the request - **Client ID** OAuth client ID that’s registered with Azure - **Client Secret** Client secret that corresponds to the client ID - **Token URL** Endpoint URL of the OAuth token service provider - **Scopes** Scopes to request during the OAuth dance The following image shows an example of the Azure Active Directory OAuth 2.0 connection configuration values: ![Example values for the OAuth 2.0 Connection Provider connection type](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-oauth2-connection-provider.png) Figure 1. OAuth 2.0 Connection Provider authentication fields ### Shared Access Signature Authentication Enter the following information on the **General** tab of the **Global Element Properties** screen to configure **Shared Access Signature** authentication: - **Storage Account Name** Azure storage account name - **DNS Suffix** DNS suffix of the Azure storage account. In most cases it’s 'dfs.core.windows.net'. - **SAS Token** SAS token for the Azure storage account The following image shows an example of the **Shared Access Signature** connection configuration values: ![Example values for the Shared Access Signature connection type](/mulesoft/current/en-us/azure-data-lake-storage-connector/latest/_images/azure-data-lake-shared-access-config.png) Figure 2. Shared Access Signature authentication fields ### Shared Key Connection Authentication Enter the following information on the **General** tab of the **Global Element Properties** screen to configure **Shared Key Connection** authentication: - **Storage Account Name** Name of the Azure Data Lake Storage account - **DNS Suffix** DNS suffix of the Azure Data Lake Storage account. In most cases it’s 'dfs.core.windows.net'. - **X-MS Version** Version of the REST API protocol used for processing the request - **Account Key** Password used to access the Azure Data Lake Storage account ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, you can try the [Examples](https://docs.mulesoft.com/azure-data-lake-storage-connector/latest/azure-data-lake-connector-examples) for common use cases. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Azure Data Lake Storage Connector Reference](https://docs.mulesoft.com/azure-data-lake-storage-connector/latest/azure-data-lake-connector-reference) - [Salesforce Help](https://help.salesforce.com)