Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

How to Upgrade a Client Agent

Updated: June 12, 2015


SQL Azure Data Sync Icon

If any of your sync groups include an on-premises SQL Server database, you must have the current client agent installed. You can install an agent from SQL Database at the Azure Management portal. (See Install a SQL Data Sync Client Agent.)

Before you can add an on-premises SQL Server database to your sync group, you must register it with the agent. (See Register a SQL Server database with a Client Agent.)

The current client agent version is 4.2.5658. You can download the latest client agent from client agent download site.

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.

Before you upgrade, check to see if you need to. If you have version 4.2.5605 or later, you do not need to upgrade.

There are two ways to determine the version of the installed client agent.

  • From the client agent UI.

    1. Make sure your client agent is running.
      If the client agent isn’t running the UI shows version 0.0.0.

      1. Click Start.

      2. Type services.msc in the search textbox.

      3. In the results pane, click the services program.

      4. Scroll down to Microsoft SQL Data Sync.

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

    2. Navigate to where you installed the client agent.

    3. Find and launch the application SqlAzureDataSyncAgent.

    4. Find the version in the lower-right corner of the client agent UI. (Figure 1.1)

      Use the agent UI to determine the agent's version
      Figure 1: SQL Data Sync Status, Agent Name, and Agent Version

  • From Start -> Control Panel -> Programs and Features.

    1. From the Start menu, click Control Panel.

    2. Click Programs and Features.

    3. Scroll down to Microsoft SQL Data Sync.

    4. Find the version number in the far right column. (Figure 2)

      Use Add/Remove programs to find agent's version
      Figure 2: Agent Version

If your client agent version is 4.2.5605 or later, you do not need to upgrade.

SQL Data Sync client agent require .NET Framework 4.5 or above. If you only have .NET Framework 4 installed, prior to upgrade, please download the .NET Framework 4.5 from here and install.

Go to the client agent download site and follow the instructions in Install a SQL Data Sync Client Agent under the Steps to install a client agent section, starting with step 5, to install the new agent. Please choose the same folder as where your old agent was installed.

Best Practice

Back Up: All of your SQL Data Sync agent and on premises database information is stored in AgentConfigData.xml. Before upgrading, we suggest that you follow these steps to back up the file, in case you encounter any issues and need to restore your settings later.

  1. Start Windows Explorer.

  2. Navigate to the folder where the current SQL Data Sync was installed. The default installation path is:

    32-bit systems: C:\Program Files\Microsoft SQL Data Sync

    64-bit systems: C:\Program Files (x86)\Microsoft SQL Data Sync

  3. Find and make a copy of AgentConfigData.xml.

Restore: If you uninstalled your old agent and then reinstalled a new one, or if you installed the upgrade agent in a different folder than the old one, you can restore your previous settings on agent and on premise by following the below procedure. Note that the new agent must be installed on the same computer as the one AgentConfigData.xml is copied from. For more information, see the Back Up section above.

  1. Start Windows Explorer.

  2. Navigate to the data folder of the newly installed client agent:

    32-bit systems: C:\Program Files\Microsoft SQL Data Sync\data

    64-bit systems: C:\Program Files (x86)\Microsoft SQL Data Sync\data

  3. Paste the AgentConfigData.xml file (backed up previously) into the data folder.

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft