Sync Agents - Create Or Update

Referenz

Service:: SQL Database

API Version:: 2021-11-01

Erstellt oder aktualisiert einen Synchronisierungs-Agent.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}?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.
syncAgentName	path	True	string	Der Name des Synchronisierungs-Agents.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.syncDatabaseId	string	ARM-Ressourcen-ID der Synchronisierungsdatenbank im Synchronisierungs-Agent.

Antworten

Name	Typ	Beschreibung
200 OK	SyncAgent	Der Synchronisierungs-Agent wurde erfolgreich aktualisiert.
201 Created	SyncAgent	Der Synchronisierungs-Agent wurde erfolgreich erstellt.
202 Accepted		Das Erstellen oder Aktualisieren des Synchronisierungs-Agents wird ausgeführt.
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. 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden. 409 SyncOperation_AgentAlreadyExists: Der Synchronisierungs-Agent mit demselben Namen ist bereits vorhanden. 409 SyncOperation_AgentIdAlreadyExists: Der Synchronisierungs-Agent mit derselben ID ist bereits vorhanden. 409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut: Der Vorgang ist timeout und wird automatisch zurückgesetzt. Wiederholen Sie den Vorgang. 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Create a new sync agent

Update a sync agent

Create a new sync agent

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

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SyncAgentInner;

/** Samples for SyncAgents CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentCreate.json
     */
    /**
     * Sample code: Create a new sync agent.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createANewSyncAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().createOrUpdate("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187",
            new SyncAgentInner().withSyncDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"),
            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

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

Update a sync agent

Sample Request

HTTP
Java

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

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SyncAgentInner;

/** Samples for SyncAgents CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentUpdate.json
     */
    /**
     * Sample code: Update a sync agent.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().createOrUpdate("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187",
            new SyncAgentInner().withSyncDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"),
            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

{
  "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"
}

Status code:: 201

{
  "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"
}

Status code:: 202

Definitionen

Name	Beschreibung
SyncAgent	Ein Azure SQL Datenbanksynchronisierungs-Agent.
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.

SyncAgentState

Status des Synchronisierungs-Agents.

Name	Typ	Beschreibung
NeverConnected	string
Offline	string
Online	string

Sync Agents - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a new sync agent

Sample Request

Sample Response

Update a sync agent

Sample Request

Sample Response

Definitionen

SyncAgent

SyncAgentState

Zusätzliche Ressourcen