Sync Agents - List By Server

Service:

SQL Database

API Version:

2021-11-01

Lists sync agents in a server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server on which the sync agent is hosted.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	SyncAgentListResult	Successfully retrieved the list of sync agents.
Other Status Codes		*** Error Responses: *** 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty. 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty. 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty. 400 InvalidDatabaseResourceId - Invalid database resource identifier. 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url. 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier. 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url. 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url. 400 InvalidParameterValue - An invalid value was given to a parameter. 400 MissingServerName - The Server name is missing 400 MissingDatabaseName - The Database name is missing 400 MissingSyncGroupName - The Sync Group name is missing 400 MissingConflictResolutionPolicy - The Conflict Resolution Policy is missing 400 MissingSyncAgentName - The Sync Agent name is missing 400 SyncOperation_GenericFailure - Failed to perform data sync operation. 400 SyncOperation_WrongSyncDatabase - The sync database specified does not match the existing one. 400 SyncOperation_DwInSyncGroup - Cannot use datawarehouse edition in data sync. 400 SyncOperation_MasterDbInSyncGroup - Cannot use logical master in data sync. 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member. 400 InvalidSyncAgent - Sync agent is invalid. 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid. 404 ResourceNotFound - The requested resource was not found. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 409 SyncOperation_AgentAlreadyExists - The sync agent with the same name already exists. 409 SyncOperation_AgentIdAlreadyExists - The sync agent with the same id already exists.

Examples

Get sync agents under a server

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for SyncAgents ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentListByServer.json
     */
    /**
     * Sample code: Get sync agents under a server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSyncAgentsUnderAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().listByServer("syncagentcrud-65440",
            "syncagentcrud-8475", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
        "state": "NeverConnected",
        "isUpToDate": true,
        "expiryTime": "9999-12-31T23:59:59.9999999Z",
        "version": "4.2.0.0"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
      "name": "syncagent",
      "type": "Microsoft.Sql/servers/syncAgents"
    }
  ]
}

Definitions

Name	Description
SyncAgent	An Azure SQL Database sync agent.
SyncAgentListResult	A list of sync agents.
SyncAgentState	State of the sync agent.

SyncAgent

An Azure SQL Database sync agent.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.expiryTime	string	Expiration time of the sync agent version.
properties.isUpToDate	boolean	If the sync agent version is up to date.
properties.lastAliveTime	string	Last alive time of the sync agent.
properties.name	string	Name of the sync agent.
properties.state	SyncAgentState	State of the sync agent.
properties.syncDatabaseId	string	ARM resource id of the sync database in the sync agent.
properties.version	string	Version of the sync agent.
type	string	Resource type.

SyncAgentListResult

A list of sync agents.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	SyncAgent[]	Array of results.

SyncAgentState

State of the sync agent.

Name	Type	Description
NeverConnected	string
Offline	string
Online	string