This integration is certified by Stitch. For support, contact Stitch support.
Microsoft Azure feature snapshot
A high-level look at Stitch's Microsoft Azure (v06-01-2016) integration, including release status, useful links, and the features supported in Stitch.
|Configurable Replication Methods||
|Full Table Replication||
Connecting Microsoft Azure
Microsoft Azure setup requirements
To set up Microsoft Azure in Stitch, you need:
Privileges in Microsoft Azure that allow you to create/manage users. This is required to create the Stitch database user.
Step 1: Configure database connection settings
In this step, you’ll configure the database server to allow traffic from Stitch to access it. There are two ways to connect your database:
- A direct connection will work if your database is publicly accessible.
- An SSH tunnel is required if your database isn’t publicly accessible. This method uses a publicly accessible instance, or an SSH server, to act as an intermediary between Stitch and your database. The SSH server will forward traffic from Stitch through an encrypted tunnel to the private database.
Click the option you’re using below and follow the instructions.
For the connection from Stitch to be successful, you’ll need to configure the firewall for your instance to allow access from our IP addresses.
- Sign into your account.
If you aren’t automatically brought to your dashboard, navigate there.
- In the sidenav, click SQL databases.
- On the page that displays, click the name of the database you want to connect to Stitch.
- The details page for the database will display. Click the link in the Server name field.
The details page for the server will display. Click the Show firewall settings link in the Firewalls and virtual networks field.
- For each of Stitch’s IP addresses listed below, create a rule:
- Rule name: Enter a name for the rule. For example:
- Start IP: Paste one of Stitch’s IP addresses.
- End IP: Paste the same IP address.
Stitch’s IP addresses are:
- Rule name: Enter a name for the rule. For example:
- Click the three dots to the right of the End IP field to add the rule.
Repeat steps 7 and 8 until there is a rule for each IP address. The screen should look similar to the following when you’re finished:
- Click Save.
- Follow the steps in the Setting up an SSH Tunnel for a Microsoft Azure database guide to set up an SSH tunnel for Microsoft Azure.
- Complete the steps in this guide after the SSH setup is complete.
Step 2: Create a Stitch database user
Next, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.
Creating a user with
SELECT privileges can either be done via a query or the Microsoft Azure UI. In this section, we’ll walk you through using the query method.
Depending on your setup and the access you grant to the Stitch database user, you may need to create several Microsoft Azure integrations to allow Stitch to replicate all your data. This is due to a Microsoft Azure limitation on how access is granted to
If the Stitch user has access to the master database and this database is then used for authentication, you can replicate all databases that the user has access to from a single Microsoft Azure integration setup.
If the database you’re replicating isn’t the master database, you’ll only be able to replicate schemas and tables within that database. This will require creating additional Microsoft Azure integrations in Stitch.
us_english. Issues with replication may arise if a different setting is used.
Create the Stitch database user, replacing
<database_name>with the name of the database and
<password>with a secure password:
USE <database_name> CREATE LOGIN <stitch_username> WITH PASSWORD='<password>' CREATE USER <stitch_username> FOR LOGIN
Grant the Stitch user
SELECTprivileges. To grant
SELECTprivileges to all tables in the database, run this command:
GRANT SELECT to <stitch_username>
If you want to limit the Stitch user to specific tables, run this command instead:
GRANT SELECT ON <schema_name>.<table_name> TO <stitch_username>
See the Privileges list tab for an explanation of why these permissions are required by Stitch.
In the table below are the database user privileges Stitch requires to connect to and replicate data from a Microsoft Azure database.
|Privilege name||Reason for requirement|
Required to select rows from tables in a database.
|VIEW CHANGE TRACKING||
Required to use Log-based Incremental Replication. Required to obtain change tracking information from tables where change tracking is enabled.
Step 3: Connect Stitch
In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.
Step 3.1: Define the database connection details
- If you aren’t signed into your Stitch account, sign in now.
On the Stitch Dashboard page, click the Add Integration button.
- Locate and click the Microsoft Azure icon.
Fill in the fields as follows:
Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Microsoft Azure” would create a schema called
stitch_microsoft_azurein the destination. Note: The schema name cannot be changed after the integration is saved.
Host (Endpoint): Enter the host address (endpoint) used by the Microsoft Azure instance. This is usually a server endpoint like
Port: Enter the port used by the instance. The default is
Username: Enter the Stitch Microsoft Azure user’s username. We recommend copying and pasting the username Microsoft Azure displays to you directly into this field. Note: Verify that the name includes
'@domain'or you’ll run into connection issues.
Password: Enter the password for the Stitch Microsoft Azure database user.
Database: Optional: Enter the name of the default database Stitch will connect to. Stitch will ‘find’ all databases you give the Stitch user access to - a default database is only used to test and complete the connection.
Step 3.2: Define the SSH connection details
If you’re using an SSH tunnel to connect your Microsoft Azure database to Stitch, you’ll also need to define the SSH settings. Refer to the Setting up an SSH Tunnel for a Microsoft Azure database guide for assistance with completing these fields.
- Click the Encryption Type menu.
Select SSH to display the SSH fields.
Fill in the fields as follows:
Remote Address: Enter the public IP address or hostname of the server Stitch will SSH into.
SSH Port: Enter the SSH port on your server. (
SSH User: Enter the Stitch Linux (SSH) user’s username.
Step 3.3: Define the SSL connection details
Click the Connect using SSL checkbox if you’re using an SSL connection. Note: The database must support and allow SSL connections for this setting to work correctly.
Step 3.4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Microsoft Azure integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Select data to replicate
The last step is to select select the tables and columns you want to replicate.
You can select tables and columns by:
- In the Integration Details page, click the Tables to Replicate tab.
- Locate a table you want to replicate.
- Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
- If there are child objects, they’ll automatically display and you’ll be prompted to select some.
After you set a table to replicate, the Settings page will display. Note: When you track a table, by default all columns will also be tracked.
In the Settings page, define the table’s Replication Method and, if using Key-based Incremental Replication, its Replication Key.
- Repeat this process for every table you want to replicate.
Initial and historical replication jobs
After you finish setting up Microsoft Azure, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.