Sync Groups - Create Or Update

Referenz

Dienst:: SQL Database

API-Version:: 2023-08-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=2023-08-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. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
syncGroupName	path	True	string	Der Name der Synchronisierungsgruppe.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.conflictLoggingRetentionInDays	integer (int32)	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 für die Synchronisierungsgruppenhubdatenbank.
properties.hubDatabaseUserName	string	Benutzername für die Anmeldeinformationen für die Synchronisierungsgruppenhubdatenbank.
properties.interval	integer (int32)	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 verwendet wird, ist die Verbindung aktiviert.
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. Header Location: string
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 InvalidSyncGroupCreateOrUpdateRequest – Der Anforderungstext der Synchronisierungsgruppe erstellen oder aktualisieren ist leer. 400 InvalidSyncMemberCreateOrUpdateRequest – Der Anforderungstext für das Erstellen oder Aktualisieren des Synchronisierungsmitglieds ist leer. 400 InvalidSyncAgentCreateOrUpdateRequest – Der Anforderungstext des Create- oder Update-Synchronisierungs-Agent ist leer. 400 InvalidDatabaseResourceId – Ungültiger Datenbankressourcenbezeichner. 400 InvalidSyncGroupName – Der Name der Synchronisierungsgruppe ist ungültig. Dieses Feld kann Buchstaben, Zahlen, Striche und Unterstriche enthalten. 400 InvalidSyncMemberName – Der Name des Synchronisierungsmitglieds ist ungültig. Dieses Feld kann Buchstaben, Zahlen, Striche und Unterstriche enthalten. 400 MissingSyncMemberName – Der Name des Synchronisierungsmitglieds fehlt. 400 InvalidSyncGroupInterval – Synchronisierungsintervall sollte größer oder gleich 5 Sekunden sein. 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 – Ein ungültiger Wert wurde einem Parameter 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 InvalidSyncGroup – 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 aufgrund des überschrittenen Kontingents nicht erstellt werden. 400 SyncOperation_DuplicateSyncGroupDrop – Die Synchronisierungsgruppe wird bereits gelöscht. 400 SyncOperation_WrongSyncDatabase – Die angegebene Synchronisierungsdatenbank stimmt nicht mit dem vorhandenen überein. 400 SyncOperation_UpdateSyncGroupWhenDropping – Die Synchronisierungsgruppe kann nicht aktualisiert werden, da sie zurzeit gelöscht wird. 400 SyncOperation_DwInSyncGroup – Datawarehouse Edition kann nicht in der Datensynchronisierung verwendet werden. 400 SyncOperation_MasterDbInSyncGroup – Logisches Master-Shape kann nicht in der Datensynchronisierung verwendet werden. 400 SyncOperation_UnsupportedDataTypeColumnInSchema – Spalte kann nicht zum Schema hinzugefügt werden, da der Datentyp der Spalte nicht unterstützt wird. 400 SyncOperation_InvalidCredential – Die Anmeldeinformationen der Datenbank sind ungültig. 400 InvalidSyncMetadataDatabase – Die Synchronisierungsmetadatendatenbank 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 in dieser Serverinstanz nicht vorhanden ist. 404 SyncOperation_HubServerNotFound – Logischer Hubserver ist nicht vorhanden. 404 SyncOperation_InvalidHubDatabase – 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 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Create a sync group

Update a sync group

Create a sync group

Beispielanforderung

HTTP

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=2023-08-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
  }
}

Beispiel für eine Antwort

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

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

Statuscode:: 202

Update a sync group

Beispielanforderung

HTTP

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=2023-08-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
  }
}

Beispiel für eine Antwort

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

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

Statuscode:: 202

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Sku	Eine ARM-Ressourcen-SKU.
SyncConflictResolutionPolicy	Konfliktlösungsrichtlinie der Synchronisierungsgruppe.
SyncGroup	Eine Azure SQL-Datenbanksynchronisierungsgruppe.
SyncGroupSchema	Eigenschaften des Synchronisierungsgruppenschemas.
SyncGroupSchemaTable	Eigenschaften der Tabelle im Synchronisierungsgruppenschema.
SyncGroupSchemaTableColumn	Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.
SyncGroupState	Synchronisierungsstatus der Synchronisierungsgruppe.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Sku

Objekt

Eine ARM-Ressourcen-SKU.

Name	Typ	Beschreibung
capacity	integer (int32)	Kapazität der jeweiligen SKU.
family	string	Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU 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	Die Stufe oder Edition der jeweiligen SKU, z. B. Basic, Premium.

SyncConflictResolutionPolicy

Enumeration

Konfliktlösungsrichtlinie der Synchronisierungsgruppe.

Wert	Beschreibung
HubWin
MemberWin

SyncGroup

Objekt

Eine Azure SQL-Datenbanksynchronisierungsgruppe.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.conflictLoggingRetentionInDays	integer (int32)	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 für die Synchronisierungsgruppenhubdatenbank.
properties.hubDatabaseUserName	string	Benutzername für die Anmeldeinformationen für die Synchronisierungsgruppenhubdatenbank.
properties.interval	integer (int32)	Synchronisierungsintervall der Synchronisierungsgruppe.
properties.lastSyncTime	string (date-time)	Zeitpunkt der letzten Synchronisierung der Synchronisierungsgruppe.
properties.privateEndpointName	string	Der Name des privaten Endpunkts der Synchronisierungsgruppe, wenn die Private Link-Verbindung 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 verwendet wird, ist die Verbindung aktiviert.
sku	Sku	Der Name und die Kapazität der SKU.
type	string	Ressourcentyp.

SyncGroupSchema

Objekt

Eigenschaften des Synchronisierungsgruppenschemas.

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

SyncGroupSchemaTable

Objekt

Eigenschaften der Tabelle im Synchronisierungsgruppenschema.

Name	Typ	Beschreibung
columns	SyncGroupSchemaTableColumn[]	Liste der Spalten im Synchronisierungsgruppenschema.
quotedName	string	Zitierter Name der Schematabelle der Synchronisierungsgruppe.

SyncGroupSchemaTableColumn

Objekt

Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.

Name	Typ	Beschreibung
dataSize	string	Datengröße der Spalte.
dataType	string	Datentyp der Spalte.
quotedName	string	Zitierter Name der Spalte "Synchronisierungsgruppentabelle".

SyncGroupState

Enumeration

Synchronisierungsstatus der Synchronisierungsgruppe.

Wert	Beschreibung
Error
Good
NotReady
Progressing
Warning

Freigeben über

Sync Groups - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a sync group

Beispielanforderung

Beispiel für eine Antwort

Update a sync group

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Zusätzliche Ressourcen