Sync Groups - Create Or Update

Serviço:: SQL Database

Versão da API:: 2023-08-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=2023-08-01

Parâmetros do URI

Name	Em	Necessá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 da API do Azure Resource Manager ou 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 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	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	Atualizado com êxito o grupo de sincronização.
201 Created	SyncGroup	Criado com êxito o grupo de sincronização.
202 Accepted		A criação ou atualização do grupo de sincronização está em andamento. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 InvalidSyncGroupCreateOrUpdateRequest - O corpo da solicitação de grupo de sincronização de criação ou atualização está vazio. 400 InvalidSyncMemberCreateOrUpdateRequest - O corpo da solicitação de membro de sincronização de criação ou atualização 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 InvalidSyncGroupName - O nome do grupo de sincronização é inválido. Este campo pode conter letras, números, traços e sublinhados. 400 InvalidSyncMemberName - O nome do membro de sincronização é inválido. Este campo pode conter letras, números, traços e sublinhados. 400 MissingSyncMemberName - O nome do membro de sincronização está ausente 400 InvalidSyncGroupInterval - O intervalo de sincronização deve ser maior ou igual a 5 segundos. 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 correspondia 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á faltando 400 MissingDatabaseName - O nome do banco de dados está faltando 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 grupo de sincronização devido à quota 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 do datawarehouse na sincronização de dados. 400 SyncOperation_MasterDbInSyncGroup - Não é possível usar o mestre lógico na sincronização de dados. 400 SyncOperation_UnsupportedDataTypeColumnInSchema - Não é possível adicionar coluna ao esquema porque o tipo de dados da coluna não é suportado. 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 do hub é inválido. 404 OperationIdNotFound - A operação com Id não existe. 409 SyncOperation_DuplicateSyncGroupName - Não é possível criar grupo de sincronização porque o grupo de sincronização com o mesmo nome já existe. 409 CannotCancelOperation - A operação de gerenciamento está em um estado que não pode ser cancelado. 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 do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, tente novamente a operação. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos 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=2023-08-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
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncGroupCreate.json
// this example is just showing the usage of "SyncGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta da amostra

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

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

Código de estado:: 202

Update a sync group

Pedido de amostra

HTTP
dotnet

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=2023-08-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
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncGroupUpdate.json
// this example is just showing the usage of "SyncGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta da amostra

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

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

Código de estado:: 202

Definições

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

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 destino 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
MemberWin

SyncGroup

Object

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

Name	Tipo	Description
id	string	ID do recurso.
name	string	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	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.
type	string	Tipo de recurso.

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
Error
Warning
Progressing
Good

Partilhar via

Sync Groups - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create a sync group

Pedido de amostra

Resposta da amostra

Update a sync group

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState