Skip to content

Commit 292a8ac

Browse files
authored
Merge pull request #213496 from ecfan/sftp-clean
Azure Logic Apps: Remove obsolete content from old SFTP doc
2 parents 1e1a8c5 + 3043614 commit 292a8ac

File tree

1 file changed

+4
-121
lines changed

1 file changed

+4
-121
lines changed

articles/connectors/connectors-create-api-sftp.md

Lines changed: 4 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -6,132 +6,15 @@ ms.suite: integration
66
author: divyaswarnkar
77
ms.reviewer: estfan, azla
88
ms.topic: how-to
9-
ms.date: 11/01/2019
9+
ms.date: 10/01/2022
1010
tags: connectors
1111
ROBOTS: NOINDEX
1212
---
1313

1414
# Connect to SFTP from workflows in Azure Logic Apps (Deprecated)
1515

16-
> [!IMPORTANT]
17-
> Please use the [SFTP-SSH connector](../connectors/connectors-sftp-ssh.md) as the SFTP connector is deprecated. You can no longer select SFTP
18-
> triggers and actions in the workflow designer.
16+
The SFTP connector is deprecated, so this connector's operations no longer appear in the workflow designer. However, you can use the [SFTP-SSH connector](/connectors/sftpwithssh/) instead. For more information, see [Connect to an SFTP file server using SSH in Azure Logic Apps](connectors-sftp-ssh.md).
1917

20-
To automate tasks that monitor, create, send, and receive files on a [Secure File Transfer Protocol (SFTP)](https://www.ssh.com/ssh/sftp/) server, you can build and automate integration workflows by using Azure Logic Apps and the SFTP connector. SFTP is a network protocol that provides file access, file transfer, and file management over any reliable data stream. Here are some example tasks you can automate:
18+
Next steps:
2119

22-
* Monitor when files are added or changed.
23-
* Get, create, copy, update, list, and delete files.
24-
* Get file content and metadata.
25-
* Extract archives to folders.
26-
27-
You can use triggers that monitor events on your SFTP server and make output available to other actions. You can use actions that perform various tasks on your SFTP server. You can also have other actions in your logic app use the output from SFTP actions. For example, if you regularly retrieve files from your SFTP server, you can send email alerts about those files and their content by using the Office 365 Outlook connector or Outlook.com connector. If you're new to logic apps, review [What is Azure Logic Apps?](../logic-apps/logic-apps-overview.md)
28-
29-
## Limitations
30-
31-
The SFTP connector handles only files that are *50 MB or smaller* and doesn't support [message chunking](../logic-apps/logic-apps-handle-large-messages.md). For larger files, use the [SFTP-SSH connector](../connectors/connectors-sftp-ssh.md). For differences between the SFTP connector and the SFTP-SSH connector, review [Compare SFTP-SSH versus SFTP](../connectors/connectors-sftp-ssh.md#comparison) in the SFTP-SSH article.
32-
33-
34-
* The SFTP-SSH managed or Azure-hosted connector for Consumption and Standard workflows handles only files that are *50 MB or smaller* and doesn't support [message chunking](../logic-apps/logic-apps-handle-large-messages.md). For larger files, use the [SFTP-SSH connector](../connectors/connectors-sftp-ssh.md). For differences between the SFTP connector and the SFTP-SSH connector, review [Compare SFTP-SSH versus SFTP](../connectors/connectors-sftp-ssh.md#comparison) in the SFTP-SSH article.
35-
36-
By default, FTP actions can read or write files that are *50 MB or smaller*. To handle files larger than 50 MB, FTP actions support [message chunking](../logic-apps/logic-apps-handle-large-messages.md). The **Get file content** action implicitly uses chunking.
37-
38-
* The SFTP-SSH managed or Azure-hosted connector can create a limited number of connections to the SFTP server, based on the connection capacity in the Azure region where your logic app resource exists. If this limit poses a problem in a Consumption logic app workflow, consider creating a Standard logic app workflow and use the SFTP-SSH built-in connector instead.
39-
40-
## Prerequisites
41-
42-
* An Azure account and subscription. If you don't have an Azure subscription, [sign up for a free Azure account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
43-
44-
* Your SFTP server address and account credentials, which let your logic app access your SFTP account. To use the [Secure Shell (SSH)](https://www.ssh.com/ssh/protocol/) protocol, you also need access to an SSH private key and the SSH private key password.
45-
46-
> [!NOTE]
47-
>
48-
> The SFTP connector supports these private key formats:
49-
> OpenSSH, ssh.com, and PuTTY
50-
>
51-
> When you're creating your logic app, after you add
52-
> the SFTP trigger or action you want, you'll need
53-
> to provide connection information for your SFTP server.
54-
> If you're using an SSH private key, make sure you
55-
> ***copy*** the key from your SSH private key file,
56-
> and ***paste*** that key into the connection details,
57-
> ***Don't manually enter or edit the key***,
58-
> which might cause the connection to fail.
59-
> For more information, see the later steps in this article.
60-
61-
* Basic knowledge about [how to create logic apps](../logic-apps/quickstart-create-first-logic-app-workflow.md)
62-
63-
* The logic app where you want to access your SFTP account. To start with an SFTP trigger, [create a blank logic app](../logic-apps/quickstart-create-first-logic-app-workflow.md). To use an SFTP action, start your logic app with another trigger, for example, the **Recurrence** trigger.
64-
65-
## How SFTP triggers work
66-
67-
SFTP triggers work by polling the SFTP file system and looking for any file that was changed since the last poll. Some tools let you preserve the timestamp when the files change. In these cases, you have to disable this feature so your trigger can work. Here are some common settings:
68-
69-
| SFTP client | Action |
70-
|-------------|--------|
71-
| Winscp | Go to **Options** > **Preferences** > **Transfer** > **Edit** > **Preserve timestamp** > **Disable** |
72-
| FileZilla | Go to **Transfer** > **Preserve timestamps of transferred files** > **Disable** |
73-
|||
74-
75-
When a trigger finds a new file, the trigger checks that the new file is complete, and not partially written. For example, a file might have changes in progress when the trigger checks the file server. To avoid returning a partially written file, the trigger notes the timestamp for the file that has recent changes, but doesn't immediately return that file. The trigger returns the file only when polling the server again. Sometimes, this behavior might cause a delay that is up to twice the trigger's polling interval.
76-
77-
## Connect to SFTP
78-
79-
[!INCLUDE [Create connection general intro](../../includes/connectors-create-connection-general-intro.md)]
80-
81-
1. Sign in to the [Azure portal](https://portal.azure.com), and open your logic app in Logic App Designer, if not open already.
82-
83-
1. For blank logic apps, in the search box, enter "sftp" as your filter. Under the triggers list, select the trigger you want.
84-
85-
-or-
86-
87-
For existing logic apps, under the last step where you want to add an action, choose **New step**. In the search box, enter "sftp" as your filter. Under the actions list, select the action you want.
88-
89-
To add an action between steps, move your pointer over the arrow between steps. Choose the plus sign (**+**) that appears, and then select **Add an action**.
90-
91-
1. Provide the necessary details for your connection.
92-
93-
> [!IMPORTANT]
94-
>
95-
> When you enter your SSH private key in the
96-
> **SSH private key** property, follow these
97-
> additional steps, which help make sure you provide
98-
> the complete and correct value for this property.
99-
> An invalid key causes the connection to fail.
100-
101-
Although you can use any text editor, here are sample steps that show how to correctly copy and paste your key by using Notepad.exe as an example.
102-
103-
1. Open your SSH private key file in a text editor. These steps use Notepad as the example.
104-
105-
1. On the Notepad **Edit** menu, select **Select All**.
106-
107-
1. Select **Edit** > **Copy**.
108-
109-
1. In the SFTP trigger or action you added, paste the *complete* key you copied into the **SSH private key** property, which supports multiple lines. ***Make sure you paste*** the key. ***Don't manually enter or edit the key***.
110-
111-
1. When you're done entering the connection details, choose **Create**.
112-
113-
1. Provide the necessary details for your selected trigger or action and continue building your logic app's workflow.
114-
115-
## Examples
116-
117-
<a name="file-add-modified"></a>
118-
119-
### SFTP trigger: When a file is added or modified
120-
121-
This trigger starts a logic app workflow when a file is added or changed on an SFTP server. For example, you can add a condition that checks the file's content and gets the content based on whether the content meets a specified condition. You can then add an action that gets the file's content, and puts that content in a folder on the SFTP server.
122-
123-
**Enterprise example**: You can use this trigger to monitor an SFTP folder for new files that represent customer orders. You can then use an SFTP action such as **Get file content** so you get the order's contents for further processing and store that order in an orders database.
124-
125-
<a name="get-content"></a>
126-
127-
### SFTP action: Get content
128-
129-
This action gets the content from a file on an SFTP server. So for example, you can add the trigger from the previous example and a condition that the file's content must meet. If the condition is true, the action that gets the content can run.
130-
131-
## Connector reference
132-
133-
For technical details about triggers, actions, and limits, which are described by the connector's OpenAPI (formerly Swagger) description, review the connector's [reference page](../data-factory/connector-sftp.md).
134-
135-
## Next steps
136-
137-
* Learn about other [Logic Apps connectors](../connectors/apis-list.md)
20+
* [Managed connector reference for Azure Logic Apps](/connectors/connector-reference/connector-reference-logicapps-connectors)

0 commit comments

Comments
 (0)