Change an Agent's Key (SDS)
Updated: February 12, 2014
A SQL Data Sync (Preview) client agent key can only be used once by an agent. It cannot be reused when you remove then reinstall a new agent, nor can it be used by multiple agents. If you need to create a new key for an existing agent you must be sure that the same key is recorded with the client agent and with the SQL Data Sync service.
This article covers how to change the key for a local SQL Data Sync (Preview) client agent.
If you do not have a client agent and need to install one, see the topics Install a SQL Data Sync (Preview) Client Agent and Register a SQL Server Database with a 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.
Modifications you can make to a sync group include:
- Update a Sync Group Schema (SDS)
- Add a Database to your Sync Group (SDS)
- Remove a Database from a Sync Group (SDS)
- Delete a Sync Group (SDS)
- Manually Deprovision a Database
- Cancel a Synchronization (SDS)
- How To: Change an Agent's Key (SDS) - this topic
Change a client agent’s key
Follow these steps to change a client agent’s key.
Navigate your browser to the Azure Platform portal.
Click SQL Databases in the left pane.
Click the Sync (Preview) tab.
From the list, select the agent whose key you want to change by clicking anywhere on the agent’s row except the agent’s name.
Click Manage Key.
Click Generate. (Figure 1.1)
Copy the new key to your clipboard. (Figure 1.2)
To close the Manage access key dialog, click the check mark in the lower right corner of the dialog. (Figure 1.3)
Submit the new key.
Go to where you installed the agent and launch SqlAzureDataSyncAgent.
See step 13 in Install a SQL Data Sync (Preview) Client Agent.
Click Submit Agent Key.
Paste the agent key from your clipboard into the text box.
Close the textbox dialog box.
Close the agent UI.
- Go to where you installed the agent and launch SqlAzureDataSyncAgent.
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.
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