Sync Groups - List By Database

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Lista grupos de sincronização em um banco de dados de hub.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups?api-version=2021-11-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.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Name	Tipo	Description
200 OK	SyncGroupListResult	Recuperada com êxito a lista de grupos de sincronização.
Other Status Codes		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 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_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. 409 SyncOperation_DuplicateSyncGroupName - Não é possível criar grupo de sincronização porque o grupo de sincronização com o mesmo nome já existe.

Name

Tipo

Description

200 OK

SyncGroupListResult

Recuperada com êxito a lista de grupos de sincronização.

Other Status Codes

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 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_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.
409 SyncOperation_DuplicateSyncGroupName - Não é possível criar grupo de sincronização porque o grupo de sincronização com o mesmo nome já existe.

Exemplos

List sync groups under a given database

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups?api-version=2021-11-01


/**
 * Samples for SyncGroups ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupListByDatabase.json
     */
    /**
     * Sample code: List sync groups under a given database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSyncGroupsUnderAGivenDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().listByDatabase("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", com.azure.core.util.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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "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"
    },
    {
      "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-5374"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-5374",
      "name": "syncgroupcrud-5374",
      "type": "Microsoft.Sql/servers/databases/syncGroups"
    }
  ]
}

Definições

Name	Description
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.
SyncGroupListResult	Uma lista de grupos de sincronização.
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

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 (arm-id)	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.

SyncGroupListResult

Object

Uma lista de grupos de sincronização.

Name	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	SyncGroup[]	Matriz de resultados.

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

Partilhar via

Sync Groups - List By Database

Parâmetros do URI

Respostas

Exemplos

List sync groups under a given database

Pedido de amostra

Resposta da amostra

Definições

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupListResult

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Recursos adicionais