Register a SQL Server Database with a Client Agent
Updated: February 12, 2014
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.
How To: Register a SQL Server Database with the Client Agent
|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.Critical:
Be sure that you do not register the same database with multiple agents as this can lead to a synchronization loop.Critical:
Be sure that you do not register the same database multiple times with the same agent.
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.
Launch the program SqlAzureDataSyncAgent.exe.
Click Edit Agent Key. (Figure 1:1)
Paste the agent key into the text box (Figure 2) and click OK.
Click Ping Sync Service to ensure that the Data Sync is running and reachable. (Figure 1:2)
If you need to start the service
Type services.msc in the Search programs and files textbox.
Double-click Services.msc found under Programs in the results window.
Find the SQL Data Sync (Preview) Preview service.
If its status is not Started, right-click the service, select Start, and press Enter.
Figure 1: Agent UI
Figure 2: Enter agent key
- Click Start.
Register a local SQL Server database with the agent.
For each local SQL Server database you want to register:
Click Register. (Figure 1:3)
Click the appropriate Authentication tab. (Figure 3:1)
Enter the host server name and the database name. (Figure 3:2)
If needed, enter your credentials. (Figure 3:3)
If you want to use an SSL connection for this server, check the Enable SSL connection with SQL Server checkbox. (Figure 3:4)
Click Test Connection. (Figure 3:5)
If the connection fails ensure the above information is correct, and then re-click Test Connection.
After the connection succeeds, click Save. (Figure 3:6)
Figure 3: Register a SQL Server database
- Click Register. (Figure 1:3)
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.
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.
ConceptsSQL Data Sync
SQL Data Sync (Preview) Community Resources
SQL Database Data Types supported by SQL Data Sync (Preview)
Data Security in SQL Data Sync (Preview)
Conflict Resolution when Synchronizing
SQL Data Sync (Preview)Troubleshooting Guide
Glossary of SQL Data Sync Terms
Other ResourcesKnown SQL Data Sync Issues
Azure Management Portal
SQL Azure Data Sync [Channel 9 videos]
SQL Data Sync Forum