Sync Groups - Create Or Update

Referência

Service:: SQL Database

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados no qual o grupo de sincronização está hospedado.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
syncGroupName	path	True	string	O nome do grupo de sincronização.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome	Tipo	Description
properties.conflictLoggingRetentionInDays	integer	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	Senha para a credencial do banco de dados do hub de grupo de sincronização.
properties.hubDatabaseUserName	string	Nome de usuário para a credencial do banco de dados do hub de grupo de sincronização.
properties.interval	integer	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 do 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 do SKU.

Respostas

Nome	Tipo	Description
200 OK	SyncGroup	O grupo de sincronização foi atualizado com êxito.
201 Created	SyncGroup	O grupo de sincronização foi criado com êxito.
202 Accepted		A criação ou atualização do grupo de sincronização está em andamento.
Other Status Codes		Respostas de erro: *** 400 InvalidSyncGroupCreateOrUpdateRequest - O corpo da solicitação do grupo de sincronização criar ou atualizar está vazio. 400 InvalidSyncMemberCreateOrUpdateRequest – O corpo da solicitação de membro de sincronização criar ou atualizar está vazio. 400 InvalidSyncAgentCreateOrUpdateRequest – O corpo da solicitação do agente de sincronização de criação ou atualização está vazio. 400 InvalidDatabaseResourceId – Identificador de recurso de banco de dados inválido. 400 MismatchingSubscriptionWithUrl – A assinatura fornecida não correspondeu à assinatura na URL. 400 InvalidSyncAgentResourceId – Identificador de recurso do agente de sincronização inválido. 400 MismatchingResourceGroupNameWithUrl - O nome do grupo de recursos fornecido não correspondeu ao nome na URL. 400 MismatchingServerNameWithUrl – O nome do servidor fornecido não correspondeu ao nome na URL. 400 InvalidParameterValue - Um valor inválido foi dado a um parâmetro. 400 MissingServerName - O nome do servidor está ausente 400 MissingDatabaseName - O nome do banco de dados está ausente 400 MissingSyncGroupName - O nome do Grupo de Sincronização está ausente 400 MissingConflictResolutionPolicy - A Política de Resolução de Conflitos está ausente 400 MissingSyncAgentName - O nome do Agente de Sincronização está ausente 400 SyncOperation_GenericFailure – Falha ao executar a operação de sincronização de dados. 400 InvalidSyncGroup – O grupo de sincronização é inválido. 400 FeatureDisabledOnSelectedEdition – o usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados. 400 CannotCreateSyncGroupDueToQuotaExceeded - Não é possível criar um grupo de sincronização devido à cota excedida. 400 SyncOperation_DuplicateSyncGroupDrop - O grupo de sincronização já está sendo descartado. 400 SyncOperation_WrongSyncDatabase – o banco de dados de sincronização especificado não corresponde ao existente. 400 SyncOperation_UpdateSyncGroupWhenDropping – Não é possível atualizar o grupo de sincronização porque ele está sendo descartado no momento. 400 SyncOperation_DwInSyncGroup – Não é possível usar a edição datawarehouse na sincronização de dados. 400 SyncOperation_MasterDbInSyncGroup – Não é possível usar master lógica na sincronização de dados. 400 SyncOperation_InvalidCredential – a credencial do banco de dados é inválida. 400 InvalidSyncMetadataDatabase – O banco de dados de metadados de sincronização é inválido. 400 SyncOperation_InvalidSyncInterval – Não é possível criar ou atualizar o grupo de sincronização porque o intervalo de sincronização é inválido. 404 ResourceNotFound – O recurso solicitado não foi encontrado. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 DatabaseDoesNotExist – o usuário especificou um nome de banco de dados que não existe nesta instância do servidor. 404 SyncOperation_HubServerNotFound – O servidor lógico do Hub não existe. 404 SyncOperation_InvalidHubDatabase – o banco de dados hub é inválido. 404 OperationIdNotFound – A operação com id não existe. 409 SyncOperation_DuplicateSyncGroupName – Não é possível criar um grupo de sincronização porque o grupo de sincronização com o mesmo nome já existe. 409 OperationCancelled – A operação foi cancelada pelo usuário. 409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

Create a sync group

Update a sync group

Create a sync group

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=2021-11-01

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SyncGroupInner;
import com.azure.resourcemanager.sql.models.SyncConflictResolutionPolicy;

/** Samples for SyncGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupCreate.json
     */
    /**
     * Sample code: Create a sync group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187",
            new SyncGroupInner().withInterval(-1).withConflictResolutionPolicy(SyncConflictResolutionPolicy.HUB_WIN)
                .withSyncDatabaseId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withHubDatabaseUsername("hubUser").withUsePrivateLinkConnection(true),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Status code:: 201

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

Status code:: 202

Update a sync group

Sample Request

HTTP
Java

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=2021-11-01

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SyncGroupInner;
import com.azure.resourcemanager.sql.models.SyncConflictResolutionPolicy;

/** Samples for SyncGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupUpdate.json
     */
    /**
     * Sample code: Update a sync group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187",
            new SyncGroupInner().withInterval(-1).withConflictResolutionPolicy(SyncConflictResolutionPolicy.HUB_WIN)
                .withSyncDatabaseId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withHubDatabaseUsername("hubUser").withUsePrivateLinkConnection(true),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Status code:: 201

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

Status code:: 202

Definições

Nome	Description
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 de 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.

Sku

Um SKU de recurso do ARM.

Nome	Tipo	Description
capacity	integer	Capacidade do SKU específico.
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 do SKU, normalmente, uma letra + Código de número, por exemplo, P3.
size	string	Tamanho do SKU específico
tier	string	A camada ou edição do SKU específico, por exemplo, Básico, Premium.

SyncConflictResolutionPolicy

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

Nome	Tipo	Description
HubWin	string
MemberWin	string

SyncGroup

Um grupo de sincronização de banco de dados SQL do Azure.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.conflictLoggingRetentionInDays	integer	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	Senha para a credencial do banco de dados do hub de grupo de sincronização.
properties.hubDatabaseUserName	string	Nome de usuário para a credencial do banco de dados do hub de grupo de sincronização.
properties.interval	integer	Intervalo de sincronização do grupo de sincronização.
properties.lastSyncTime	string	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 usar a conexão de link privado estiver habilitada.
properties.schema	SyncGroupSchema	Esquema de sincronização do grupo de sincronização.
properties.syncDatabaseId	string	ID de recurso do 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 do SKU.
type	string	Tipo de recurso.

SyncGroupSchema

Propriedades do esquema de grupo de sincronização.

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

SyncGroupSchemaTable

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 do grupo de sincronização.

SyncGroupSchemaTableColumn

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 de grupo de sincronização.

SyncGroupState

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

Nome	Tipo	Description
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

Sync Groups - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a sync group

Sample Request

Sample Response

Update a sync group

Sample Request

Sample Response

Definições

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Recursos adicionais