Skip to main content
Documentation
Troubleshooting
Feature Requests Status

Azure Synapse Setup Guide

Edit on GitHub
  • Updated
Fivetran System User Fivetranner

Follow our setup guide to connect your Azure Synapse data warehouse to Fivetran.

Prerequisiteslink

To connect Azure Synapse to Fivetran, you need the following:

  • Permissions to create a user for Fivetran
  • Fivetran account owner permission to add destinations
  • Permissions to add or change resource classes for user

Setup instructionslink

Choose connection method link

Decide whether to connect to your Azure Synapse data warehouse directly, using an SSH tunnel, or using Azure Private Link. For more information, see our destination connection options documentation.

Connect directly

If you connect directly, you must create a rule in a security group that allows Fivetran access to your Synapse instance and port.

Configure your firewall and/or other access control systems to allow incoming connections to your host and port from Fivetran’s IPs for your region.

Connect using an SSH tunnel

If you connect using an SSH tunnel, Fivetran connects to a separate server in your network that provides an SSH tunnel to your Azure Synapse data warehouse. You must then configure your tunnel server’s security group to allow Fivetran access and configure the instance’s security to allow access from the tunnel.

You must connect through SSH if your data warehouse is contained within an inaccessible subnet.

To connect using SSH, do the following:

  1. In the destination setup form, select the Connect via an SSH tunnel option.

  2. Copy Fivetran’s public SSH key.

  3. Add the public key to the authorized_keys file of your SSH server. The key must be all on one line, so make sure that you don’t introduce any line breaks when cutting and pasting.

Connect using Azure Private Link

IMPORTANT: You must have a Business Critical plan to use Azure Private Link.

If you select Private Link as a connection method, Fivetran uses Azure Private Link to move your data securely between our system and your destination.

To set up Private Link for your Azure Synapse destination, follow the instructions in the Azure Private Link section.

Create warehouselink

Create a warehouse using your Azure portal.

Find server detailslink

  1. Go to the Azure portal.

  2. Click Azure Synapse Analytics.

  3. Click on the SQL pool you created in Step 2.

  4. In the Server name field, find the fully qualified server name and database name. Make a note of the names. You will need them to complete the destination setup in Fivetran.

Configure server-level firewalllink

Add Fivetran’s IP address in your server-level firewall to allow incoming connections to your Azure Synapse data warehouse from Fivetran.

See Azure’s documentation on how to create a server-level firewall rule for more information.

Create a Fivetran userlink

  1. Connect to your Azure Synapse data warehouse using SQL Server Management Studio or SQL Pro as an Admin user.

  2. Execute the following SQL command to create a Fivetran user in the master database:

    CREATE LOGIN fivetran WITH PASSWORD = '<password>';

  3. Execute the following SQL commands to create a Fivetran user in the data warehouse:

    CREATE USER fivetran_user_without_login without login;
CREATE USER fivetran FOR LOGIN fivetran;
GRANT IMPERSONATE on USER::fivetran_user_without_login to fivetran;

  4. Grant CONTROL permissions to the Fivetran user. Execute the following command:

    GRANT CONTROL to fivetran;

    NOTE: We need CONTROL permission to create database scoped credentials that we use while loading files from Blob Storage using PolyBase.

Add resource classlink

Add a suitable resource class to the Fivetran user depending upon the memory requirement for columnstore index creation. We recommend using static resource classes. You can start with the staticrc20 resource class that allocates 200 MB for the user irrespective of the performance level.

NOTE: Some connectors need higher resource class because of the higher number of columns. Higher volume of data requires more memory to create columnstore indexes. See Microsoft’s documentation on memory and concurrency limits and resource classes for more information.

You must increase the allocated resource class, if the columnstore indexing fails with the current resource class. Execute the following command to increase the resource class:

 EXEC sp_addrolemember '<resource_class_name>', 'fivetran';

(Optional) Azure Private Link BETAlink

IMPORTANT: You must have a Business Critical plan to use Azure Private Link.

Fivetran uses Private Link to move your data securely between our system and your Azure Synapse destination.

Prerequisites

To set up Azure Private Link, you need:

  • A Fivetran instance configured to run in Azure
  • An Azure Synapse destination in one of our supported regions

Configure Private Link for Azure Synapse destination

  1. In the Azure portal, open your Azure Synapse workspace.

  2. On the Security tab, select Private endpoint connections.

  3. Click + Private endpoint.

  4. In the Create a private endpoint window, select your subscription and region details:

    i. On the Basics tab, choose your Subscription and Resource group.

    ii. Enter the Name for the private endpoint.

    iii. Select your Region.

    iv. Click Next: Resource>.

  5. Select your Azure Synapse workspace details:

    i. On the Resource tab, select the Connect to an Azure resource in my directory option.

    ii. Select the Subscription that contains your Azure Synapse workspace.

    iii. Set the Resource type to Microsoft.Synapse/workspaces.

    iv. In the Resource drop-down menu, select your Azure Synapse workspace.

    v. Click Next: Configuration>.

  6. On the Configuration tab, select the Virtual network and Subnet for the private endpoint. You must also create a DNS record that maps to the endpoint.

  7. In the Integrate with private DNS zone, select Yes to integrate your private endpoint with a private DNS zone.

    NOTE: If you don’t have a private DNS zone associated with your Microsoft Azure Virtual Network, then a new private DNS zone is created.

  8. Click Review + create.

  9. When the deployment completes, open your Azure Synapse workspace and go to Private endpoint connections. Make a note of the new private endpoint URL. You will need it to configure Fivetran.

NOTE: For more information, read Microsoft’s Azure Synapse workspace connection documentation.

Complete Fivetran configuration link

  1. Log in to your Fivetran account.

  2. Go to the Manage Account page.

  3. In the Destinations tab, click +Destination.

  4. On the Add Destination To Fivetran page, enter a Destination Name of your choice.

  5. Click Add Destination.

  6. Select Azure Synapse as the destination type.

  7. In the destination setup form’s Host field, enter one of the following values:

  8. Enter the Port number.

  9. Enter your User name. Your username must follow the fivetran@<server_name> format, where <server_name> is part of your Azure host URL: <server_name>.database.windows.net.

  10. Enter your Password.

  11. Enter the Database name you found in Step 3.

  12. Choose your Connection method:

    • Connect directly
    • Connect via an SSH tunnel
    • Connect via Private Link

      NOTE: The Connect via Private Link option is only available for Business Critical accounts.

  13. (Optional) If you choose Connect via an SSH tunnel, enter the following details:

    • SSH Host
    • SSH Port
    • SSH User

  14. Choose the Data processing location. Depending on the plan you are on and your selected cloud service provider, you may also need to choose a Cloud service provider and Azure region as described in our Destinations documentation.

  15. Choose your Timezone.

  16. Click Save and Test.

Fivetran tests and validates the Azure Synapse connection. Upon successful completion of the setup tests, you can sync your data using Fivetran connectors to the Azure Synapse destination.

Setup testslink

Fivetran performs the following Azure Synapse connection tests:

  • The Database Host Connection Test validates the database credentials you provided in the setup form. The test verifies that the host is not private and then checks the connectivity to the host.

  • The SSH Tunnel Test validates the SSH tunnel details you provided in the setup form and then checks the connectivity to the instance using the SSH Tunnel if you are connecting using an SSH tunnel.

  • The UserName Has ServerName Test verifies the user details you provided in the setup form. The test checks if you have appended the server name to the user name. For example, fivetran@server_name.

  • The Azure Warehouse Connection Test checks the connectivity to the data warehouse.

  • The Azure Warehouse Type Test checks if you are using Microsoft Azure SQL Data Warehouse.

  • The Azure Warehouse Permission Test checks if we have permissions to create schemas and tables on the database.

    NOTE: The tests may take a couple of minutes to finish running.

Related Contentlink

description Destination Overview

assignment Release Notes

settings API Destination Configuration

home Documentation Home

Related articles

Didn’t find what you need?

Contact support