Sync Groups - Create Or Update

Dienst:: SQL Database

API-Version:: 2025-01-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=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
syncGroupName	path	True	string	Der Name der Synchronisierungsgruppe.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang 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 (password)	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 Aktualisierung der Ressource 'SyncGroup' war erfolgreich
201 Created	SyncGroup	Die Erstellungsoperation der Ressource 'SyncGroup' war erfolgreich Header Location: string Retry-After: integer
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

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=2025-01-01

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

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=2025-01-01

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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Statuscode:: 202

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
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-Datenbank Sync Group.
SyncGroupSchema	Eigenschaften des Synchronisierungsgruppenschemas.
SyncGroupSchemaTable	Eigenschaften der Tabelle im Synchronisierungsgruppenschema.
SyncGroupSchemaTableColumn	Eigenschaften der Spalte in der Synchronisierungsgruppentabelle.
SyncGroupState	Synchronisierungsstatus der Synchronisierungsgruppe.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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	HubWin
MemberWin	MemberWin

SyncGroup

Objekt

Eine Azure SQL-Datenbank Sync Group.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
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 (password)	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.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

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
NotReady	NotReady
Error	Fehler
Warning	Warnung
Progressing	Fortschritte
Good	Gut

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.