Share via


Configure an SFTP Destination

 

Important

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

Lists the steps to create an SFTP Destination in Azure BizTalk Services.

Note

To successfully route messages to an SFTP Destination, the SFTP FileName must be added as a Route Action. This FileName can either be a promoted property from the SFTP Source or it could be hardcoded as an expression.

Add an SFTP Destination

  1. Create a BizTalk Service project. Steps at Get started with a Visual Studio project.

  2. Right-click anywhere on the BizTalk Service project design area, select Properties. For the BizTalk Service URL property, enter your BizTalk Services URL.

  3. From the Toolbox, drag and drop the SFTP component under Route Destinations to the BizTalk Service project design area.

  4. Right-click the component and select Properties. The following table provides information about the properties:

    Property

    Description

    Entity Name

    Specify a unique and descriptive name of the SFTP Destination component.

    Folder Path

    Specify the folder on the SFTP server to put the messages. For example, if you want to put all XML messages in the CustomerFiles\Contoso SFTP folder, enter CustomerFiles\Contoso.

    Password

    Enter the username password that can put files on the SFTP server.

    Server Address

    Enter the SFTP server name or IP address.

    Server Port

    Enter the SFTP server port. Default is 22.

    Username

    Enter the username that can put files on the SFTP server.

  5. From the File menu, select Save

Authentication

  • Server Authentication: The SFTP Source and SFTP Destination trust all server certificates.

  • Client Authentication: Enter a username and password that can get/put files on the SFTP computer folder. This is exactly the same as logging into an FTP server.

Additional

SSH File Transfer Protocol (SFTP) is a common protocol used to securely transfer files between two external partners. SFTP has become one the preferred methods to transfer files. BizTalk Services includes SFTP functionality that enables you to send messages to an SFTP server. This topic lists the steps to use an SFTP server as a message destination in a BizTalk Service project. Use this destination to push a message to a folder on an SFTP server.

The SFTP Destination component can be used as the destination to an XML One-Way Bridge or a Pass-Through Bridge. An SFTP Destination cannot be used a destination for XML Request-Reply Bridge. Create and Configure a Bridge provides details on how to configure these bridges. After you have added a bridge and the SFTP Destination component to the design area, select Connector from the Toolbox, and connect the SFTP Destination to the bridge.

See Also

Add a Message Destination to the bridge