Connect to an SFTP file server from workflows in Azure Logic Apps
Applies to: Azure Logic Apps (Consumption + Standard)
This how-to guide shows how to access your SSH File Transfer Protocol (SFTP) server from a workflow in Azure Logic Apps. SFTP is a network protocol that provides file access, file transfer, and file management over any reliable data stream and uses the Secure Shell (SSH) protocol.
In Consumption logic app workflows, you can use the SFTP-SSH managed connector, while in Standard logic app workflows, you can use the SFTP built-in connector or the SFTP-SSH managed connector. You can use these connector operations to create automated workflows that run when triggered by events in your SFTP server or in other systems and run actions to manage files on your SFTP server. Both the managed and built-in connectors use the SSH protocol.
Note
The SFTP managed connector has been deprecated, so this connector's operations no longer appear in the workflow designer.
For example, your workflow can start with an SFTP trigger that monitors and responds to events on your SFTP server. The trigger makes the outputs available to subsequent actions in your workflow. Your workflow can run SFTP actions that get, create, and manage files through your SFTP server account. The following list includes more example tasks:
- Monitor when files are added or changed.
- Get, create, copy, rename, update, list, and delete files.
- Create folders.
- Get file content and metadata.
- Extract archives to folders.
The following steps use the Azure portal, but with the appropriate Azure Logic Apps extension, you can also use the following tools to create and edit logic app workflows:
Consumption logic app workflows: Visual Studio or Visual Studio Code
Standard logic app workflows: Visual Studio Code
Connector technical reference
The SFTP connector has different versions, based on logic app type and host environment.
| Logic app type (plan) | Environment | Connector version |
|---|---|---|
| Consumption | Multitenant Azure Logic Apps | Managed connector, which appears in the connector gallery under Runtime > Shared. For more information, review the following documentation: - SFTP-SSH managed connector reference - Managed connectors in Azure Logic Apps |
| Standard | Single-tenant Azure Logic Apps and App Service Environment v3 (Windows plans only) | Managed connector, which appears in the connector gallery under Runtime > Shared, and built-in connector, which appears in the connector gallery under Runtime > In-App and is service provider-based. The built-in connector can directly connect to an SFTP server and access Azure virtual networks by using a connection string without an on-premises data gateway. For more information, review the following documentation: - SFTP-SSH managed connector reference - SFTP built-in connector reference - Managed connectors in Azure Logic Apps - Built-in connectors in Azure Logic Apps |
General limitations
Before you use the SFTP-SSH managed connector, see SFTP-SSH managed connector reference - known issues and limitations.
Before you use the SFTP built-in connector, see SFTP built-in connector reference - known issues and limitations.
Known issues
By default, triggers that return an array have a Split On setting that's already enabled. With this setting enabled, the trigger automatically debatches the array by internally creating a separate workflow instance to process each array item. All the workflow instances run in parallel so that the array items are processed at the same time.
However, when the Split On setting is enabled, managed connector triggers return the outputs for all the array items as lists. Any subsequent actions that reference these outputs have to first handle these outputs as lists. To handle each array item individually, you can add extra actions. For example, to iterate through these array items, you can use a For each loop. For triggers that return only metadata or properties, use an action that gets the array item's metadata first, and then use an action to get the items contents.
You have to apply this approach only for managed connector triggers, not built-in connector triggers that return outputs for one array item at a time when the Split On setting is enabled.
For example, suppose you have managed connector trigger named When a file is added or modified (properties only) that returns the metadata or properties for the new or updated files as arrays. To get the metadata separately for each file, you might use a For each loop that iterates through the array. In this loop, use the following managed connector actions in the specified order:
Get file metadata to get each file's metadata.
Get file content action to get each file's content.
Chunking
For more information about how the SFTP-SSH managed connector can handle large files exceeding default size limits, see SFTP-SSH managed connector reference - Chunking.
Prerequisites
An Azure account and subscription. If you don't have an Azure subscription, sign up for a trial Azure subscription.
Connection and authentication information to access your SFTP server, such as the server address, account credentials, access to an SSH private key, and the SSH private key password. For more information, see SFTP-SSH managed connector reference - Authentication and permissions.
Important
When you create your connection and enter your SSH private key in the SSH private key property, make sure to follow the steps for providing the complete and correct value for this property. Otherwise, a non-valid key causes the connection to fail.
The logic app workflow where you want to access your SFTP account. To start with an SFTP-SSH trigger, you have to start with a blank workflow. To use an SFTP-SSH action, start your workflow with another trigger, such as the Recurrence trigger.
Add an SFTP trigger
In the Azure portal, open your Consumption logic app with blank workflow in the designer.
In the designer, follow these general steps to add the SFTP-SSH trigger that you want.
If prompted, provide the necessary connection information. When you're done, select Create.
After the trigger information box appears, provide the necessary details for your selected trigger. For more information, see SFTP-SSH managed connector triggers reference.
When you're done, save your workflow. On the designer toolbar, select Save.
When you save your workflow, this step automatically publishes your updates to your deployed logic app, which is live in Azure. With only a trigger, your workflow just checks the FTP server based on your specified schedule. You have to add an action that responds to the trigger and does something with the trigger outputs.
For example, the trigger named When a file is added or modified starts a workflow when a file is added or changed on an SFTP server. As a subsequent action, you can add a condition that checks whether the file content meets your specified criteria. If the content meets the condition, use the action named Get file content to get the file content, and then use another action to put that file content into a different folder on the SFTP server.
Add an SFTP action
Before you can use an SFTP action, your workflow must already start with a trigger, which can be any kind that you choose. For example, you can use the generic Recurrence built-in trigger to start your workflow on specific schedule.
In the Azure portal, open your Consumption logic app with workflow in the designer.
In the designer, follow these general steps to add the SFTP-SSH action that you want.
If prompted, provide the necessary connection information. When you're done, select Create.
After the action information box appears, provide the necessary details for your selected action. For more information, see SFTP-SSH managed connector actions reference.
When you're done, save your workflow. On the designer toolbar, select Save.
For example, the action named Get file content using path gets the content from a file on an SFTP server by specifying the file path. You can use the trigger from the previous example and a condition that the file content must meet. If the condition is true, a subsequent action can get the content.
Troubleshooting
For more information, see the following documentation: