Sync Groups - Create Or Update

Tjänst:: SQL Database

API-version:: 2025-01-01

Skapar eller uppdaterar en synkroniseringsgrupp.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
syncGroupName	path	True	string	Namnet på synkroniseringsgruppen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Kvarhållningsperiod för konfliktloggning.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Princip för konfliktlösning för synkroniseringsgruppen.
properties.enableConflictLogging	boolean	Om konfliktloggning är aktiverat.
properties.hubDatabasePassword	string (password)	Lösenord för autentiseringsuppgifterna för synkroniseringsgruppens hubbdatabas.
properties.hubDatabaseUserName	string	Användarnamn för autentiseringsuppgifterna för synkroniseringsgruppens hubbdatabas.
properties.interval	integer (int32)	Synkroniseringsintervall för synkroniseringsgruppen.
properties.schema	SyncGroupSchema	Synkroniseringsschema för synkroniseringsgruppen.
properties.syncDatabaseId	string	ARM-resurs-ID för synkroniseringsdatabasen i synkroniseringsgruppen.
properties.usePrivateLinkConnection	boolean	Om du använder privat länk är anslutningen aktiverad.
sku	Sku	SKU:ns namn och kapacitet.

Svar

Name	Typ	Description
200 OK	SyncGroup	Resursens 'SyncGroup'-uppdateringsoperation lyckades
201 Created	SyncGroup	Resursen 'SyncGroup'-skapande lyckades Sidhuvuden Location: string Retry-After: integer
202 Accepted		Resursåtgärden har godkänts. Sidhuvuden Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create a sync group

Update a sync group

Create a sync group

Exempelbegäran

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

Exempelsvar

Statuskod:: 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
  }
}

Statuskod:: 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
  }
}

Statuskod:: 202

Update a sync group

Exempelbegäran

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

Exempelsvar

Statuskod:: 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
  }
}

Statuskod:: 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
  }
}

Statuskod:: 202

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
Sku	En ARM-resurs-SKU.
SyncConflictResolutionPolicy	Princip för konfliktlösning för synkroniseringsgruppen.
SyncGroup	An Azure SQL Database sync group.
SyncGroupSchema	Egenskaper för synkroniseringsgruppsschema.
SyncGroupSchemaTable	Egenskaper för tabellen i synkroniseringsgruppschemat.
SyncGroupSchemaTableColumn	Egenskaper för kolumnen i synkroniseringsgrupptabellen.
SyncGroupState	Synkroniseringstillstånd för synkroniseringsgruppen.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

Sku

Objekt

En ARM-resurs-SKU.

Name	Typ	Description
capacity	integer (int32)	Kapacitet för den specifika SKU:n.
family	string	Om tjänsten har olika generationer av maskinvara, för samma SKU, kan den samlas in här.
name	string	Namnet på SKU:n, vanligtvis en bokstav + nummerkod, t.ex. P3.
size	string	Storleken på den specifika SKU:n
tier	string	Nivån eller utgåvan av den specifika SKU:n, t.ex. Basic, Premium.

SyncConflictResolutionPolicy

Uppräkning

Princip för konfliktlösning för synkroniseringsgruppen.

Värde	Description
HubWin	HubWin
MemberWin	MemberWin

SyncGroup

Objekt

An Azure SQL Database sync group.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.conflictLoggingRetentionInDays	integer (int32)	Kvarhållningsperiod för konfliktloggning.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Princip för konfliktlösning för synkroniseringsgruppen.
properties.enableConflictLogging	boolean	Om konfliktloggning är aktiverat.
properties.hubDatabasePassword	string (password)	Lösenord för autentiseringsuppgifterna för synkroniseringsgruppens hubbdatabas.
properties.hubDatabaseUserName	string	Användarnamn för autentiseringsuppgifterna för synkroniseringsgruppens hubbdatabas.
properties.interval	integer (int32)	Synkroniseringsintervall för synkroniseringsgruppen.
properties.lastSyncTime	string (date-time)	Synkroniseringsgruppens senaste synkroniseringstid.
properties.privateEndpointName	string	Namnet på den privata slutpunkten för synkroniseringsgruppen om privat länkanslutning är aktiverad.
properties.schema	SyncGroupSchema	Synkroniseringsschema för synkroniseringsgruppen.
properties.syncDatabaseId	string	ARM-resurs-ID för synkroniseringsdatabasen i synkroniseringsgruppen.
properties.syncState	SyncGroupState	Synkroniseringstillstånd för synkroniseringsgruppen.
properties.usePrivateLinkConnection	boolean	Om du använder privat länk är anslutningen aktiverad.
sku	Sku	SKU:ns namn och kapacitet.
systemData	systemData	Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
type	string	Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

SyncGroupSchema

Objekt

Egenskaper för synkroniseringsgruppsschema.

Name	Typ	Description
masterSyncMemberName	string	Namnet på den huvudsynkroniseringsmedlem som schemat kommer från.
tables	SyncGroupSchemaTable[]	Lista över tabeller i synkroniseringsgruppschemat.

SyncGroupSchemaTable

Objekt

Egenskaper för tabellen i synkroniseringsgruppschemat.

Name	Typ	Description
columns	SyncGroupSchemaTableColumn[]	Lista över kolumner i synkroniseringsgruppsschemat.
quotedName	string	Det angivna namnet på schematabellen för synkroniseringsgrupper.

SyncGroupSchemaTableColumn

Objekt

Egenskaper för kolumnen i synkroniseringsgrupptabellen.

Name	Typ	Description
dataSize	string	Datastorlek för kolumnen.
dataType	string	Datatyp för kolumnen.
quotedName	string	Det angivna namnet på kolumnen synkroniseringsgrupptabell.

SyncGroupState

Uppräkning

Synkroniseringstillstånd för synkroniseringsgruppen.

Värde	Description
NotReady	NotReady
Error	Error
Warning	Varning
Progressing	Framsteg
Good	Bra

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Sync Groups - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create a sync group

Exempelbegäran

Exempelsvar

Update a sync group

Exempelbegäran

Exempelsvar

Definitioner

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

systemData