Freigeben über

Sync Agents - List By Server

  • Referenz
Dienst:
SQL Database
API-Version:
2021-11-01

Listen Synchronisierungs-Agents auf einem Server.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName
 path True

string

Der Name des Servers, auf dem der Synchronisierungs-Agent gehostet wird.
subscriptionId
 path True

string

Abonnement-ID für ein Azure-Abonnement.
api-version
 query True

string

API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

SyncAgentListResult

Die Liste der Synchronisierungs-Agents wurde erfolgreich abgerufen.
Other Status Codes

Fehlerantworten: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest: Der Text der Anforderung zur Erstellung oder Aktualisierung der Synchronisierungsgruppe ist leer.

  • 400 InvalidSyncMemberCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren von Synchronisierungsmitglied ist leer.

  • 400 InvalidSyncAgentCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren des Synchronisierungs-Agents ist leer.

  • 400 InvalidDatabaseResourceId: Ungültiger Datenbankressourcenbezeichner.

  • 400 MismatchingSubscriptionWithUrl: Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein.

  • 400 InvalidSyncAgentResourceId: Ungültiger Synchronisierungs-Agent-Ressourcenbezeichner.

  • 400 MismatchingResourceGroupNameWithUrl: Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein.

  • 400 MismatchingServerNameWithUrl: Der angegebene Servername stimmte nicht mit dem Namen in der URL überein.

  • 400 InvalidParameterValue: Einem Parameter wurde ein ungültiger Wert zugewiesen.

  • 400 MissingServerName: Der Servername fehlt

  • 400 MissingDatabaseName: Der Datenbankname fehlt

  • 400 MissingSyncGroupName: Der Name der Synchronisierungsgruppe fehlt

  • 400 MissingConflictResolutionPolicy: Die Konfliktlösungsrichtlinie fehlt

  • 400 MissingSyncAgentName: Der Name des Synchronisierungs-Agents fehlt

  • 400 SyncOperation_GenericFailure: Fehler beim Ausführen des Datensynchronisierungsvorgangs.

  • 400 SyncOperation_WrongSyncDatabase: Die angegebene Synchronisierungsdatenbank entspricht nicht der vorhandenen Datenbank.

  • 400 SyncOperation_DwInSyncGroup: Datawarehouse Edition kann nicht in der Datensynchronisierung verwendet werden.

  • 400 SyncOperation_MasterDbInSyncGroup: Bei der Datensynchronisierung kann keine logische master verwendet werden.

  • 400 CannotDeleteInUseSyncAgent: Synchronisierungs-Agent kann nicht gelöscht werden, da er vom Synchronisierungsmitglied verwendet wird.

  • 400 InvalidSyncAgent: Der Synchronisierungs-Agent ist ungültig.

  • 400 InvalidSyncMetadataDatabase: Die Synchronisierungsmetadatendatenbank ist ungültig.

  • 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.

  • 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden

  • 404 DatabaseDoesNotExist: Der Benutzer hat einen Datenbanknamen angegeben, der auf diesem Server instance nicht vorhanden ist.

  • 409 SyncOperation_AgentAlreadyExists: Der Synchronisierungs-Agent mit demselben Namen ist bereits vorhanden.

  • 409 SyncOperation_AgentIdAlreadyExists: Der Synchronisierungs-Agent mit derselben ID ist bereits vorhanden.

Beispiele

Get sync agents under a server

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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"
    }
  ]
}

Definitionen

Name Beschreibung
SyncAgent

Ein Azure SQL Datenbanksynchronisierungs-Agent.
SyncAgentListResult

Eine Liste der Synchronisierungs-Agents.
SyncAgentState

Status des Synchronisierungs-Agents.

SyncAgent

Ein Azure SQL Datenbanksynchronisierungs-Agent.

Name Typ Beschreibung
id

string

Ressourcen-ID
name

string

Name der Ressource.
properties.expiryTime

string

Ablaufzeit der Synchronisierungs-Agent-Version.
properties.isUpToDate

boolean

Wenn die Synchronisierungs-Agent-Version auf dem neuesten Stand ist.
properties.lastAliveTime

string

Letzte Lebenszeit des Synchronisierungs-Agents.
properties.name

string

Name des Synchronisierungs-Agents.
properties.state

SyncAgentState

Status des Synchronisierungs-Agents.
properties.syncDatabaseId

string

ARM-Ressourcen-ID der Synchronisierungsdatenbank im Synchronisierungs-Agent.
properties.version

string

Version des Synchronisierungs-Agents.
type

string

Der Ressourcentyp.

SyncAgentListResult

Eine Liste der Synchronisierungs-Agents.

Name Typ Beschreibung
nextLink

string

Link zum Abrufen der nächsten Ergebnisseite.
value

SyncAgent[]

Array von Ergebnissen.

SyncAgentState

Status des Synchronisierungs-Agents.

Name Typ Beschreibung
NeverConnected

string

Offline

string

Online

string