Sync Groups - Create Or Update

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Crea o actualiza un grupo de sincronización.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
syncGroupName	path	True	string	Nombre del grupo de sincronización.
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Período de retención de registro de conflictos.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Directiva de resolución de conflictos del grupo de sincronización.
properties.enableConflictLogging	boolean	Si el registro de conflictos está habilitado.
properties.hubDatabasePassword	string (password)	Contraseña para la credencial de base de datos del centro de grupo de sincronización.
properties.hubDatabaseUserName	string	Nombre de usuario para la credencial de base de datos del centro de grupo de sincronización.
properties.interval	integer (int32)	Intervalo de sincronización del grupo de sincronización.
properties.schema	SyncGroupSchema	Esquema de sincronización del grupo de sincronización.
properties.syncDatabaseId	string	Identificador de recurso de ARM de la base de datos de sincronización en el grupo de sincronización.
properties.usePrivateLinkConnection	boolean	Si se habilita la conexión de private link.
sku	Sku	Nombre y capacidad de la SKU.

Respuestas

Nombre	Tipo	Description
200 OK	SyncGroup	Operación de actualización del recurso 'SyncGroup' exitosa
201 Created	SyncGroup	Recurso 'SyncGroup' crear operación exitosa Encabezados Location: string Retry-After: integer
202 Accepted		Operación de recursos aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create a sync group

Update a sync group

Create a sync group

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
  }
}

status code:: 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
  }
}

status code:: 202

Update a sync group

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
  }
}

status code:: 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
  }
}

status code:: 202

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Sku	Una SKU de recursos de ARM.
SyncConflictResolutionPolicy	Directiva de resolución de conflictos del grupo de sincronización.
SyncGroup	Un grupo de sincronización de Azure SQL Database.
SyncGroupSchema	Propiedades del esquema de grupo de sincronización.
SyncGroupSchemaTable	Propiedades de la tabla en el esquema de grupo de sincronización.
SyncGroupSchemaTableColumn	Propiedades de la columna en la tabla de grupos de sincronización.
SyncGroupState	Estado de sincronización del grupo de sincronización.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Sku

Objeto

Una SKU de recursos de ARM.

Nombre	Tipo	Description
capacity	integer (int32)	Capacidad de la SKU determinada.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	El nombre de la SKU, normalmente, una letra + código de número, por ejemplo, P3.
size	string	Tamaño de la SKU determinada
tier	string	Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium.

SyncConflictResolutionPolicy

Enumeración

Directiva de resolución de conflictos del grupo de sincronización.

Valor	Description
HubWin	HubWin
MemberWin	MemberWin

SyncGroup

Objeto

Un grupo de sincronización de Azure SQL Database.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.conflictLoggingRetentionInDays	integer (int32)	Período de retención de registro de conflictos.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Directiva de resolución de conflictos del grupo de sincronización.
properties.enableConflictLogging	boolean	Si el registro de conflictos está habilitado.
properties.hubDatabasePassword	string (password)	Contraseña para la credencial de base de datos del centro de grupo de sincronización.
properties.hubDatabaseUserName	string	Nombre de usuario para la credencial de base de datos del centro de grupo de sincronización.
properties.interval	integer (int32)	Intervalo de sincronización del grupo de sincronización.
properties.lastSyncTime	string (date-time)	Hora de la última sincronización del grupo de sincronización.
properties.privateEndpointName	string	Nombre del punto de conexión privado del grupo de sincronización si se habilita la conexión de vínculo privado.
properties.schema	SyncGroupSchema	Esquema de sincronización del grupo de sincronización.
properties.syncDatabaseId	string	Identificador de recurso de ARM de la base de datos de sincronización en el grupo de sincronización.
properties.syncState	SyncGroupState	Estado de sincronización del grupo de sincronización.
properties.usePrivateLinkConnection	boolean	Si se habilita la conexión de private link.
sku	Sku	Nombre y capacidad de la SKU.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

SyncGroupSchema

Objeto

Propiedades del esquema de grupo de sincronización.

Nombre	Tipo	Description
masterSyncMemberName	string	Nombre del miembro de sincronización maestra desde el que procede el esquema.
tables	SyncGroupSchemaTable[]	Lista de tablas en el esquema de grupo de sincronización.

SyncGroupSchemaTable

Objeto

Propiedades de la tabla en el esquema de grupo de sincronización.

Nombre	Tipo	Description
columns	SyncGroupSchemaTableColumn[]	Lista de columnas en el esquema de grupo de sincronización.
quotedName	string	Nombre entre comillas de la tabla de esquemas de grupo de sincronización.

SyncGroupSchemaTableColumn

Objeto

Propiedades de la columna en la tabla de grupos de sincronización.

Nombre	Tipo	Description
dataSize	string	Tamaño de datos de la columna.
dataType	string	Tipo de datos de la columna.
quotedName	string	Nombre entre comillas de la columna de tabla de grupo de sincronización.

SyncGroupState

Enumeración

Estado de sincronización del grupo de sincronización.

Valor	Description
NotReady	NotReady
Error	Error
Warning	Advertencia
Progressing	Progreso
Good	Bueno

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.