Register a SQL Server database with a Client Agent

Register a SQL Server database with a Client Agent

Updated: August 25, 2015


SQL Azure Data Sync Icon

SQL Data Sync (Preview) synchronization groups that include one or more on-premises SQL Server databases need a client agent to manage communications between SQL Data Sync (Preview) and SQL Server databases without compromising your firewall.

After you install the client agent, you must register any SQL Server database you want to add to any sync group with the client agent. This topic walks you through registering an on-premises SQL Server database with the installed client agent.

The Microsoft Azure SQL Data Sync plug-in on the Microsoft Azure Silverlight portal has been decommissioned. Going forward, use the Microsoft Azure Management portal, for Azure SQL Data Sync.

You access SQL Data Sync (Preview) via the SYNC tab under SQL Database at the Microsoft Azure Management portal. The SYNC tab is only available when you have one or more sync groups. See the topic How To: Create a Sync Group (SDS) for guidance on creating and modifying a sync group from this portal.

See the Navigation section below for links to topics you should read before you start and guidance on creating and modifying sync groups.

<< PreviousNext >>

Be sure that service account under which the agent Host is running has permissions to connect to the on-premises database you want to register.

Be sure that you do not attempt to register a SQL Database instance with an agent.

Be sure that you do not register the same database with multiple agents as this can lead to a synchronization loop.

Be sure that you do not register the same database multiple times with the same agent.

  1. From Start -> Computer navigate to where you installed the agent.

    The default is %SYSTEMDRIVE%%PROGRAMFILES%\Microsoft SQL Data Sync\ on 32-bit computers and %SYSTEMDRIVE%%PROGRAMFILES(x86)%\Microsoft SQL Data Sync\ on 64-bit computers.

  2. Launch the program SqlAzureDataSyncAgent.exe.

  3. Click Edit Agent Key. (Figure 1:1)

  4. Paste the agent key into the text box (Figure 2) and click OK.

  5. Click Ping Sync Service to ensure that the Data Sync is running and reachable. (Figure 1:2)

    If you need to start the service

    1. Click Start.

    2. Type services.msc in the Search programs and files textbox.

    3. Double-click Services.msc found under Programs in the results window.

    4. Find the SQL Data Sync (Preview) Preview service.

    5. If its status is not Started, right-click the service, select Start, and press Enter.

      Agent UI
      Figure 1: Agent UI

      Enter agent key
      Figure 2: Enter agent key

  6. Register a local SQL Server database with the agent.

    For each local SQL Server database you want to register:

    1. Click Register. (Figure 1:3)

    2. Click the appropriate Authentication tab. (Figure 3:1)

    3. Enter the host server name and the database name. (Figure 3:2)

    4. If needed, enter your credentials. (Figure 3:3)

    5. If you want to use an SSL connection for this server, check the Enable SSL connection with SQL Server checkbox. (Figure 3:4)

    6. Click Test Connection. (Figure 3:5)

      If the connection fails ensure the above information is correct, and then re-click Test Connection.

    7. After the connection succeeds, click Save. (Figure 3:6)

      Register a database with the agent
      Figure 3: Register a SQL Server database

SQL Data Sync (Preview) is a feature of SQL Database. From the Azure Management portal you can perform all tasks necessary to create, deploy, and modify a sync group.


Before you start

Before you begin to design and implement your synchronizations, you should be familiar with these topics.

How to create a sync group

There are six steps to creating a sync group from the Azure Management portal. Details on each step can be found by following these links.

  1. Sign in to the Azure SQL Database Management portal
    SQL Data Sync (Preview) is found as a tab under SQL Database only after you create a sync group.

  2. Install a SQL Data Sync Client Agent

  3. Register a SQL Server database with a Client Agent

  4. Create your sync group

  5. Define your data sync

  6. Configure your sync group (SDS)


How to modify a sync group

You can modify a sync group’s schema by adding/removing tables or columns in the sync group; or by altering a column’s width or data type. Details can be found by following the links.

See Also

© 2015 Microsoft