Sync Groups - Create Or Update

Serviço:: SQL Database

Versão da API:: 2025-01-01

Cria ou atualiza um grupo de sincronização.

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 URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
syncGroupName	path	True	string	O nome do grupo de sincronização.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Período de retenção de log de conflitos.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Política de resolução de conflitos do grupo de sincronização.
properties.enableConflictLogging	boolean	Se o log de conflitos estiver habilitado.
properties.hubDatabasePassword	string (password)	Senha para a credencial do banco de dados do hub de sincronização.
properties.hubDatabaseUserName	string	Nome de usuário para a credencial de banco de dados do hub de grupo de sincronização.
properties.interval	integer (int32)	Intervalo de sincronização do grupo de sincronização.
properties.schema	SyncGroupSchema	Esquema de sincronização do grupo de sincronização.
properties.syncDatabaseId	string	ID do recurso ARM do banco de dados de sincronização no grupo de sincronização.
properties.usePrivateLinkConnection	boolean	Se usar a conexão de link privado estiver habilitada.
sku	Sku	O nome e a capacidade da SKU.

Respostas

Nome	Tipo	Description
200 OK	SyncGroup	Operação de atualização do recurso 'SyncGroup' bem-sucedida
201 Created	SyncGroup	Recurso 'SyncGroup' criar operação bem-sucedida Cabeçalhos Location: string Retry-After: integer
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create a sync group

Update a sync group

Create a sync group

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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
  }
}

Código de status:: 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
  }
}

Código de status:: 202

Update a sync group

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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
  }
}

Código de status:: 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
  }
}

Código de status:: 202

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Sku	Um SKU de recurso do ARM.
SyncConflictResolutionPolicy	Política de resolução de conflitos do grupo de sincronização.
SyncGroup	Um grupo de sincronização do Banco de Dados SQL do Azure.
SyncGroupSchema	Propriedades do esquema de grupo de sincronização.
SyncGroupSchemaTable	Propriedades da tabela no esquema de grupo de sincronização.
SyncGroupSchemaTableColumn	Propriedades da coluna na tabela de grupo de sincronização.
SyncGroupState	Estado de sincronização do grupo de sincronização.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Sku

Objeto

Um SKU de recurso do ARM.

Nome	Tipo	Description
capacity	integer (int32)	Capacidade da SKU específica.
family	string	Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui.
name	string	O nome da SKU, normalmente, uma letra + código de número, por exemplo, P3.
size	string	Tamanho da SKU específica
tier	string	A camada ou edição da SKU específica, por exemplo, Basic, Premium.

SyncConflictResolutionPolicy

Enumeração

Política de resolução de conflitos do grupo de sincronização.

Valor	Description
HubWin	HubWin
MemberWin	MemberWin

SyncGroup

Objeto

Um grupo de sincronização do Banco de Dados SQL do Azure.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.conflictLoggingRetentionInDays	integer (int32)	Período de retenção de log de conflitos.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Política de resolução de conflitos do grupo de sincronização.
properties.enableConflictLogging	boolean	Se o log de conflitos estiver habilitado.
properties.hubDatabasePassword	string (password)	Senha para a credencial do banco de dados do hub de sincronização.
properties.hubDatabaseUserName	string	Nome de usuário para a credencial de banco de dados do hub de grupo de sincronização.
properties.interval	integer (int32)	Intervalo de sincronização do grupo de sincronização.
properties.lastSyncTime	string (date-time)	Hora da última sincronização do grupo de sincronização.
properties.privateEndpointName	string	Nome do ponto de extremidade privado do grupo de sincronização se a conexão de link privado estiver habilitada.
properties.schema	SyncGroupSchema	Esquema de sincronização do grupo de sincronização.
properties.syncDatabaseId	string	ID do recurso ARM do banco de dados de sincronização no grupo de sincronização.
properties.syncState	SyncGroupState	Estado de sincronização do grupo de sincronização.
properties.usePrivateLinkConnection	boolean	Se usar a conexão de link privado estiver habilitada.
sku	Sku	O nome e a capacidade da SKU.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

SyncGroupSchema

Objeto

Propriedades do esquema de grupo de sincronização.

Nome	Tipo	Description
masterSyncMemberName	string	Nome do membro de sincronização mestre de onde o esquema é.
tables	SyncGroupSchemaTable[]	Lista de tabelas no esquema de grupo de sincronização.

SyncGroupSchemaTable

Objeto

Propriedades da tabela no esquema de grupo de sincronização.

Nome	Tipo	Description
columns	SyncGroupSchemaTableColumn[]	Lista de colunas no esquema de grupo de sincronização.
quotedName	string	Nome entre aspas da tabela de esquema de grupo de sincronização.

SyncGroupSchemaTableColumn

Objeto

Propriedades da coluna na tabela de grupo de sincronização.

Nome	Tipo	Description
dataSize	string	Tamanho dos dados da coluna.
dataType	string	Tipo de dados da coluna.
quotedName	string	Nome entre aspas da coluna da tabela do grupo de sincronização.

SyncGroupState

Enumeração

Estado de sincronização do grupo de sincronização.

Valor	Description
NotReady	NotReady
Error	Erro
Warning	Aviso
Progressing	Progresso
Good	Bom

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Sync Groups - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create a sync group

Solicitação de exemplo

Resposta de exemplo

Update a sync group

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

systemData