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 do URI

Name	Em	Necessá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 um 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 utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Período de retenção do registo de conflitos.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Política de resolução de conflitos do grupo de sincronização.
properties.enableConflictLogging	boolean	Se o registo de conflitos estiver ativado.
properties.hubDatabasePassword	string (password)	Senha para a credencial do banco de dados do hub do grupo de sincronização.
properties.hubDatabaseUserName	string	Nome de usuário para a credencial do banco de dados do hub do 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 de recurso ARM do banco de dados de sincronização no grupo de sincronização.
properties.usePrivateLinkConnection	boolean	Se usar conexão de link privado estiver habilitado.
sku	Sku	O nome e a capacidade do SKU.

Respostas

Name	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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create a sync group

Update a sync group

Create a sync group

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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 estado:: 202

Update a sync group

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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 estado:: 202

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Sku	Um SKU de recurso ARM.
SyncConflictResolutionPolicy	Política de resolução de conflitos do grupo de sincronização.
SyncGroup	Um grupo de sincronização do Base 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 referentes à 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

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

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

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Sku

Object

Um SKU de recurso ARM.

Name	Tipo	Description
capacity	integer (int32)	Capacidade do SKU específico.
family	string	Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name	string	O nome do SKU, normalmente, uma letra + código numérico, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	O nível ou edição do SKU específico, 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

Object

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

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado 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 do registo de conflitos.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Política de resolução de conflitos do grupo de sincronização.
properties.enableConflictLogging	boolean	Se o registo de conflitos estiver ativado.
properties.hubDatabasePassword	string (password)	Senha para a credencial do banco de dados do hub do grupo de sincronização.
properties.hubDatabaseUserName	string	Nome de usuário para a credencial do banco de dados do hub do grupo de sincronização.
properties.interval	integer (int32)	Intervalo de sincronização do grupo de sincronização.
properties.lastSyncTime	string (date-time)	Última hora de sincronização do grupo de sincronização.
properties.privateEndpointName	string	Nome do ponto de extremidade privado do grupo de sincronização se Usar conexão de link privado estiver habilitado.
properties.schema	SyncGroupSchema	Esquema de sincronização do grupo de sincronização.
properties.syncDatabaseId	string	ID de 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 conexão de link privado estiver habilitado.
sku	Sku	O nome e a capacidade do SKU.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

SyncGroupSchema

Object

Propriedades do esquema de grupo de sincronização.

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

SyncGroupSchemaTable

Object

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

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

SyncGroupSchemaTableColumn

Object

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

Name	Tipo	Description
dataSize	string	Tamanho dos dados da coluna.
dataType	string	Tipo de dados da coluna.
quotedName	string	Nome citado 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	Advertência
Progressing	Progresso
Good	Bom

systemData

Object

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

Name	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.