Skip to main content

Microsoft Azure Data Lake Store

The unified Azure Data Lake Storage (ADLS) connector lets you connect to Azure Data Lake Storage in Designer. ADLS is available as a data source through the dedicated Azure Data Lake Storage Input and Azure Data Lake Storage Output tools. Both tools use the unified connector framework and Data Connection Manager (DCM) to manage credentials.

Importante

Upgrade to the New ADLS Connector

If your workflow uses the standalone ADLS Input or OneDrive Output tools, those are now deprecated. Instead, use connector version 3.0.0 or later with the Input Data and Output Data tools. Use the workflow migration utility to update existing workflows.

Microsoft Azure Data Lake Storage Version 3.0.0

Version

Description

v3.0.0

  • Single DCM connection shared by both Input and Output tools, with four authentication methods.

  • Parquet read/write support added alongside existing CSV, XLSX, JSON, and Avro support for both tools (Parquet requires Designer 2026.2+).

  • Raw ADLS path entry and search/sort in file and folder lists on both tools

  • Workflow migration tools let both Input and Output tools convert from their legacy SDK equivalents (requires Designer 2025.2 Patch 3+).

  • Fixed an issue where File Name field was disabled when a parent folder was selected, blocking output file naming.

  • Fixed an issue where folder download returned an error

Known Issues

  • In the Input tool, Update Run has not been implemented, resulting in the field metadata unable to be fetched without actually running the workflow.

  • The Output tool may not handle custom file extensions correctly. The file extension can be replaced with the default extension for the selected file format.

  • Returning to the Read Options page for XLSX and Avro files can produce a Failed to fetch paths error with an empty file list in the Input tool.

  • The Input tool does not provide a Select All option when selecting columns is required.

Prerequisites

Ensure you have completed the following prerequisites before proceeding:

Requirement

Details

Designer Version

Designer 2026.1 or later.

Designer 2025.2 Patch 3 or later.

Designer 2025.1 Patch 5 or later.

Connector Version

Azure Data Lake Storage version 3.0.0 or later.

Storage Generation

ADLS Gen2 only.

DCM

Required. Go to Options > Advanced Settings > DCM to enable it.

Engine

AMP is required.

Azure Endpoint

Public Azure only. National cloud and custom Azure endpoints are not supported in this release.

Network Access

Outbound access to Azure Data Lake Storage Gen2 and Microsoft OAuth endpoints.

Workflow Migration Tool

2025.2 Patch 3 or later

Install the Connector

You can easily install the latest version of the ADLS connector from Designer via the Add-Ons. This is the recommended installation method that allows you to browse, install, and update connectors without leaving Designer or visiting the Alteryx Marketplace.

To install the connector...

  1. In Designer, go to Add-Ons > Manage Marketplace Add-Ons. You will see a list of available connectors.

  2. Select Microsoft Azure Data Lake Storage Tools and select Install. Designer downloads and installs the package. Designer might require a restart to complete the installation.

  3. After installation and setup are complete, the ADLS connector is available from the Azure Data Lake Storage Input and Azure Data Lake Storage Output tools.

Set up a Connection

DCM is required to set up a connection. To set up connection...

  1. Drag the Input Data or Output Data tool to the canvas, and select Connect to Data.

  2. In the Connector Setup, select Create or Browse a Data Connection.

    If you've created an ADLS connection before, you can select the connection from the Recents tab.

  3. Select + New. From the list of technologies, select Microsoft Azure Data Lake Store.

  4. Select Setup Connection. The Connections window opens.

  5. Select +New.

  6. Specify the connection name, data source name, and the server URL.

  7. In the Credentials section, select your authentication method, and enter the mandatory fields. For more information, see Authentication Methods.

  8. Select Save and then select Connect.

  9. Select the file to read from or write to in the file browser window.

  10. Select the read or write configuration in the Options window.

  11. Select Confirm to create a connection to the file. You can continue building your workflow.

Input and Output Tools

The ADLS Input and Output tools are used to read from and write to ADLS.

Azure Data Lake Storage Input

The Input tool reads data from a file in ADLS Gen2 into your workflow.

  • Supported formats: CSV, XLSX, JSON, Avro, and Parquet (Designer 2026.2 and later).

  • Selecting a file: Choose the file system (container), then navigate to the file. You can browse the folder tree, search and sort files and folders, or paste a raw ADLS path directly.

  • Input Option: On the Read Options page, select how to process the selected file or folder.

    • Read Data Only: Reads data from the file content. This is the default.

    • Read Metadata Only: Reads metadata from the file and returns it as the tool's output data.

    • Download File or Folder: Downloads the file or folder locally for later processing in the workflow.

    • Read Only List of Full Paths: Returns a list of full paths in the selected location as the tool's output data.

  • Read options: Available options vary by file format. For delimited files, you can specify the delimiter, quote character, encoding, first-row field names, starting row, and maximum field length. For XLSX files, select the sheet to read. JSON, Avro, and Parquet files have format-specific options.

Azure Data Lake Storage Output

The Output tool writes your workflow data to a file in ADLS Gen2.

  • Supported formats: CSV, XLSX, JSON, Avro, and Parquet (Designer 2026.2 and later).

  • Selecting a target: Choose the file system, then the target folder and file name. You can browse, search and sort, paste a raw path, or create a new folder in the selected file system from within the tool.

    If the file already exists. Choose Overwrite to replace the existing file, or Append to add rows to it.

  • Partitioning: On Designer 2025.2 Patch 3 and later, the Output tool can write partitioned output, laying the result out across multiple files in the target location. Partitioning is supported for XLSX output as well as the other formats.

  • Write options: Format-specific write options are available for the selected format, including the delimiter, quote character, header handling, character encoding, and, for XLSX, the target sheet.

Object Model

ADLS Gen2 addressing follows this hierarchy: Storage Account > File System (container) > Folder Path > File

The storage account is set on the DCM connection. The tools ask for the file system, folder path, and file. A raw path you paste directly must resolve to the same structure.

Authentication Methods

The unified connector authenticates through DCM. ADLS supports four authentication methods. Use the table below to choose the right one for your use case.

Method

Details

Desktop (Flagship)

Cloud (Alteryx One)

Built-in OAuth

Sign in using your credentials with the Alteryx-registered Azure application. An Azure administrator must grant consent for the application in your tenant the first time you sign in. The scope is editable.

Yes

Not available

Custom OAuth

Sign in using your credentials with your organization’s registered Azure application. Enter the application’s client ID and secret. You can edit the scope and OAuth authority URL. Use this option when your organization requires its own application registration or consent policy. For setup instructions, see Microsoft Azure API app setup.

Yes

Not available

Service to Service

Authenticate as an Azure service principal without interactive sign-in. You can edit the scope and OAuth authority URL. Use this option for unattended, scheduled, or Server executions.

Yes

Not available

Shared Key

Authenticate with the storage account access key.

Yes

Not available

Migrating from the Legacy ADLS Connector

If you already use the ADLS connector in Alteryx, read the section below. It walks through what has been changed in the unified version.

Parameter

Legacy Connector

Unified Connector

Platforms and tools

Designer Desktop only. Separate Azure Data Lake Input and Azure Data Lake Output tools installed from Marketplace.

Designer Desktop. Azure Data Lake Storage Input and Azure Data Lake Storage Output tools on the unified connector framework

Framework

Python SDK connector

Unified connector framework

Connection model

Connection configured in the tool, with optional DCM

DCM required

Storage generation

Gen1 and Gen2 historically. Gen1 authentication withdrawn

Gen2 only

File formats

CSV, XLSX, JSON, Avro

CSV, XLSX, JSON, Avro, and Parquet on Designer 2026.2 and later

Azure endpoints

Public Azure, national clouds, custom endpoints

Public Azure only

Engine

AMP required

AMP required

Limitations

  • Parquet read and write is supported only in Designer 2026.2 and later. On earlier supported versions, the connector works but Parquet is unavailable. Upgrade to Designer 2026.2 or use CSV or Avro.

  • Partitioned output, including partitioned XLSX output, is unavailable in Designer 2025.1 Patch 5. Upgrade to Designer 2025.2 Patch 3 or later, or write a single output file.

  • The unified ADLS connector is supported in Designer Desktop only.

  • The workflow migration utility does not convert legacy ADLS connections to DCM connections. Create the required DCM connections and select them on the migrated tools.

  • Returning from Read Options to file selection can result in a Failed to fetch paths or Failed to search error. Complete file selection before opening Read Options, or reopen the tool configuration.

  • The connector may replace non-standard or missing file extensions with the default extension for the selected format.

  • Output paths and XLSX target sheets cannot be driven by workflow data or parameter values. Use static paths or separate Output tools.

  • Append is supported only for formats where appending rows is meaningful. Use Overwrite or write to a new file for unsupported formats.

  • Workflows that exceed the Azure token lifetime can fail with an authentication error. Use Service to Service authentication for long-running or scheduled workflows.

  • File size is limited by available memory, disk space, and network stability.

Ferramentas do Alteryx usadas para conexão

13 de outubro de 2025

ADLS versão 2.5.1

ID

Descrição

TPM-1630

  • Fixed issue where existing file operations returned an error.

  • Fixed issue where ADLS tools ignored proxy settings when the proxy did not require credentials.

  • Fixed issue where ADLS Output returned an error: charmap codec can't decode byte error when writing CSV files.

  • Fixed issue where ADLS Input failed to download a file to an invalid location.

  • Fixed issue where ADLS tools displayed an error when authenticating with a shared key.

  • Fixed issue where ADLS Input returned a bad argument type for built-in operation error.

Known Issues

  • Special characters in the proxy password cause an error in the manual proxy server setup.

  • The ADLS tools return the error: bad argument type for built-in operation.

  • ADLS Input removes the front zero when reading a CSV file.

Gerenciador de Conexões de Dados

As ferramentas do Azure Data Lake Store 2.3.0 e versões posteriores são compatíveis com o Gerenciador de Conexões de Dados para um armazenamento mais fácil e seguro de suas credenciais. Crie uma conexão com o Azure Data Lake Store e reutilize facilmente as credenciais armazenadas em fluxos de trabalho que incluem as ferramentas do Azure Data Lake Store. O Alteryx Server exige credenciais armazenadas para executar com êxito os fluxos de trabalho publicados.

Habilitar o AMP Engine

Certifique-se de ter o AMP Engine habilitado para os fluxos de trabalho que contêm as ferramentas do Azure Data Lake Store 2.3.0 e versões posteriores.