Sync Groups - Create Or Update

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Erstellt oder aktualisiert eine Synchronisierungsgruppe.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}?api-version=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank, in der die Synchronisierungsgruppe gehostet wird.
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	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
syncGroupName	path	True	string	Der Name der Synchronisierungsgruppe.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.conflictLoggingRetentionInDays	integer	Aufbewahrungszeitraum für die Konfliktprotokollierung.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Konfliktlösungsrichtlinie der Synchronisierungsgruppe.
properties.enableConflictLogging	boolean	Wenn die Konfliktprotokollierung aktiviert ist.
properties.hubDatabasePassword	string	Kennwort für die Anmeldeinformationen der Synchronisierungsgruppe hub-Datenbank.
properties.hubDatabaseUserName	string	Benutzername für die Anmeldeinformationen der Datenbank für den Synchronisierungsgruppenhub.
properties.interval	integer	Synchronisierungsintervall der Synchronisierungsgruppe.
properties.schema	SyncGroupSchema	Synchronisierungsschema der Synchronisierungsgruppe.
properties.syncDatabaseId	string	ARM-Ressourcen-ID der Synchronisierungsdatenbank in der Synchronisierungsgruppe.
properties.usePrivateLinkConnection	boolean	Wenn die Private Link-Verbindung verwenden aktiviert ist.
sku	Sku	Der Name und die Kapazität der SKU.

Antworten

Name	Typ	Beschreibung
200 OK	SyncGroup	Die Synchronisierungsgruppe wurde erfolgreich aktualisiert.
201 Created	SyncGroup	Die Synchronisierungsgruppe wurde erfolgreich erstellt.
202 Accepted		Das Erstellen oder Aktualisieren der Synchronisierungsgruppe wird ausgeführt.
Other Status Codes		Fehlerantworten: *** 400 InvalidSyncGroupCreateOrUpdateRequest: Der Anforderungstext der Synchronisierungsgruppe erstellen oder aktualisieren ist leer. 400 InvalidSyncMemberCreateOrUpdateRequest: Der Anforderungstext zum Erstellen oder Aktualisieren von Synchronisierungsmitglied ist leer. 400 InvalidSyncAgentCreateOrUpdateRequest: Der Anforderungstext des Synchronisierungs-Agents zum Erstellen oder Aktualisieren 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 Konfliktauflösungsrichtlinie fehlt 400 MissingSyncAgentName: Der Name des Synchronisierungs-Agents fehlt 400 SyncOperation_GenericFailure: Fehler beim Ausführen des Datensynchronisierungsvorgangs. 400 InvalidSyncGroup: Die Synchronisierungsgruppe ist ungültig. 400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 CannotCreateSyncGroupDueToQuotaExceededed: Synchronisierungsgruppe kann nicht erstellt werden, da das Kontingent überschritten wurde. 400 SyncOperation_DuplicateSyncGroupDrop: Die Synchronisierungsgruppe wird bereits gelöscht. 400 SyncOperation_WrongSyncDatabase: Die angegebene Synchronisierungsdatenbank stimmt nicht mit der vorhandenen Datenbank überein. 400 SyncOperation_UpdateSyncGroupWhenDropping: Die Synchronisierungsgruppe kann nicht aktualisiert werden, da sie derzeit gelöscht wird. 400 SyncOperation_DwInSyncGroup: Datawarehouse Edition kann nicht in der Datensynchronisierung verwendet werden. 400 SyncOperation_MasterDbInSyncGroup: Logische master in der Datensynchronisierung kann nicht verwendet werden. 400 SyncOperation_InvalidCredential: Anmeldeinformationen der Datenbank sind ungültig. 400 InvalidSyncMetadataDatabase: Die Metadatendatenbank der Synchronisierung ist ungültig. 400 SyncOperation_InvalidSyncInterval: Synchronisierungsgruppe kann nicht erstellt oder aktualisiert werden, da das Synchronisierungsintervall ungültig ist. 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 SyncOperation_HubServerNotFound: Der logische Hubserver ist nicht vorhanden. 404 SyncOperation_InvalidHubDatabase: Die Hubdatenbank ist ungültig. 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden. 409 SyncOperation_DuplicateSyncGroupName: Synchronisierungsgruppe kann nicht erstellt werden, da die Synchronisierungsgruppe mit demselben Namen bereits vorhanden ist. 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: Timeout des Vorgangs und automatisches Rollback. 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 sync group

Update a sync group

Create a sync group

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

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "usePrivateLinkConnection": true
  }
}


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

/** Samples for SyncGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupCreate.json
     */
    /**
     * Sample code: Create a sync group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187",
            new SyncGroupInner().withInterval(-1).withConflictResolutionPolicy(SyncConflictResolutionPolicy.HUB_WIN)
                .withSyncDatabaseId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withHubDatabaseUsername("hubUser").withUsePrivateLinkConnection(true),
            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": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Status code:: 201

{
  "properties": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Status code:: 202

Update a sync group

Sample request

HTTP
Java

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

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "usePrivateLinkConnection": true
  }
}


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

/** Samples for SyncGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupUpdate.json
     */
    /**
     * Sample code: Update a sync group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187",
            new SyncGroupInner().withInterval(-1).withConflictResolutionPolicy(SyncConflictResolutionPolicy.HUB_WIN)
                .withSyncDatabaseId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withHubDatabaseUsername("hubUser").withUsePrivateLinkConnection(true),
            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": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Status code:: 201

{
  "properties": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

Status code:: 202

Definitionen

Name	Beschreibung
Sku	Eine ARM-Ressourcen-SKU.
SyncConflictResolutionPolicy	Konfliktlösungsrichtlinie der Synchronisierungsgruppe.
SyncGroup	Eine Azure SQL-Datenbank-Synchronisierungsgruppe.
SyncGroupSchema	Eigenschaften des Synchronisierungsgruppenschemas.
SyncGroupSchemaTable	Eigenschaften der Tabelle im Synchronisierungsgruppenschema.
SyncGroupSchemaTableColumn	Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.
SyncGroupState	Synchronisierungsstatus der Synchronisierungsgruppe.

Sku

Eine ARM-Ressourcen-SKU.

Name	Typ	Beschreibung
capacity	integer	Kapazität der jeweiligen SKU.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen für dieselbe SKU verfügt, kann dies hier erfasst werden.
name	string	Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.
size	string	Größe der jeweiligen SKU
tier	string	Der Tarif oder die Edition der jeweiligen SKU, z. B. Basic, Premium.

SyncConflictResolutionPolicy

Konfliktlösungsrichtlinie der Synchronisierungsgruppe.

Name	Typ	Beschreibung
HubWin	string
MemberWin	string

SyncGroup

Eine Azure SQL-Datenbank-Synchronisierungsgruppe.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.conflictLoggingRetentionInDays	integer	Aufbewahrungszeitraum für die Konfliktprotokollierung.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Konfliktlösungsrichtlinie der Synchronisierungsgruppe.
properties.enableConflictLogging	boolean	Wenn die Konfliktprotokollierung aktiviert ist.
properties.hubDatabasePassword	string	Kennwort für die Anmeldeinformationen der Synchronisierungsgruppe hub-Datenbank.
properties.hubDatabaseUserName	string	Benutzername für die Anmeldeinformationen der Datenbank für den Synchronisierungsgruppenhub.
properties.interval	integer	Synchronisierungsintervall der Synchronisierungsgruppe.
properties.lastSyncTime	string	Zeitpunkt der letzten Synchronisierung der Synchronisierungsgruppe.
properties.privateEndpointName	string	Name des privaten Endpunkts der Synchronisierungsgruppe, wenn die Private Link-Verbindung verwenden aktiviert ist.
properties.schema	SyncGroupSchema	Synchronisierungsschema der Synchronisierungsgruppe.
properties.syncDatabaseId	string	ARM-Ressourcen-ID der Synchronisierungsdatenbank in der Synchronisierungsgruppe.
properties.syncState	SyncGroupState	Synchronisierungsstatus der Synchronisierungsgruppe.
properties.usePrivateLinkConnection	boolean	Wenn die Private Link-Verbindung verwenden aktiviert ist.
sku	Sku	Der Name und die Kapazität der SKU.
type	string	Der Ressourcentyp.

SyncGroupSchema

Eigenschaften des Synchronisierungsgruppenschemas.

Name	Typ	Beschreibung
masterSyncMemberName	string	Name master Synchronisierungsmitglieds, aus dem das Schema stammt.
tables	SyncGroupSchemaTable[]	Liste der Tabellen im Synchronisierungsgruppenschema.

SyncGroupSchemaTable

Eigenschaften der Tabelle im Synchronisierungsgruppenschema.

Name	Typ	Beschreibung
columns	SyncGroupSchemaTableColumn[]	Liste der Spalten im Schema der Synchronisierungsgruppe.
quotedName	string	Name der Schematabelle der Synchronisierungsgruppe in Anführungszeichen.

SyncGroupSchemaTableColumn

Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.

Name	Typ	Beschreibung
dataSize	string	Datengröße der Spalte.
dataType	string	Datentyp der Spalte.
quotedName	string	Name der Tabellenspalte der Synchronisierungsgruppe in Anführungszeichen.

SyncGroupState

Synchronisierungsstatus der Synchronisierungsgruppe.

Name	Typ	Beschreibung
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

Freigeben über

Sync Groups - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a sync group

Sample request

Sample response

Update a sync group

Sample request

Sample response

Definitionen

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Zusätzliche Ressourcen