Sync Groups - List Hub Schemas

Serviço:: SQL Database

Versão da API:: 2023-08-01

Obtém uma coleção de esquemas de banco de dados de hub.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas?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.

Respostas

Name	Tipo	Description
200 OK	SyncFullSchemaPropertiesListResult	Obtenha com êxito um esquema de banco de dados do hub de grupo de sincronização.
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. 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

SyncFullSchemaPropertiesListResult

Obtenha com êxito um esquema de banco de dados do hub de grupo de sincronização.

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

Get a hub database schema.

GET 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/hubSchemas?api-version=2023-08-01

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/SyncGroupGetHubSchema.json
// this example is just showing the usage of "SyncGroups_ListHubSchemas" 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 SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// invoke the operation and iterate over the result
await foreach (SyncFullSchemaProperties item in syncGroup.GetHubSchemasAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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": [
    {
      "tables": [
        {
          "columns": [
            {
              "dataSize": "4",
              "dataType": "int",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "intField",
              "quotedName": "[intField]"
            },
            {
              "dataSize": "100",
              "dataType": "nvarchar",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "charField",
              "quotedName": "[charField]"
            }
          ],
          "errorId": "Schema_TableHasNoPrimaryKey",
          "hasError": true,
          "name": "dbo.myTable",
          "quotedName": "[dbo].[myTable]"
        }
      ],
      "lastUpdateTime": "2017-05-30T07:16:08.21Z"
    }
  ]
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SyncFullSchemaProperties	Propriedades do esquema completo do banco de dados.
SyncFullSchemaPropertiesListResult	Uma lista de propriedades do esquema de sincronização.
SyncFullSchemaTable	Propriedades da tabela no esquema completo do banco de dados.
SyncFullSchemaTableColumn	Propriedades da coluna na tabela do esquema completo do banco de dados.

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.

SyncFullSchemaProperties

Object

Propriedades do esquema completo do banco de dados.

Name	Tipo	Description
lastUpdateTime	string (date-time)	Última hora de atualização do esquema de banco de dados.
tables	SyncFullSchemaTable[]	Lista de tabelas no esquema completo do banco de dados.

SyncFullSchemaPropertiesListResult

Object

Uma lista de propriedades do esquema de sincronização.

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

SyncFullSchemaTable

Object

Propriedades da tabela no esquema completo do banco de dados.

Name	Tipo	Description
columns	SyncFullSchemaTableColumn[]	Lista de colunas na tabela do esquema completo do banco de dados.
errorId	string	ID de erro da tabela.
hasError	boolean	Se houver erro na tabela.
name	string	Nome da tabela.
quotedName	string	Nome citado da tabela.

SyncFullSchemaTableColumn

Object

Propriedades da coluna na tabela do esquema completo do banco de dados.

Name	Tipo	Description
dataSize	string	Tamanho dos dados da coluna.
dataType	string	Tipo de dados da coluna.
errorId	string	ID de erro da coluna.
hasError	boolean	Se houver erro na tabela.
isPrimaryKey	boolean	Se for a chave primária da tabela.
name	string	Nome da coluna.
quotedName	string	Nome citado da coluna.

Partilhar via

Sync Groups - List Hub Schemas

Parâmetros do URI

Respostas

Exemplos

Get a hub database schema.

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncFullSchemaProperties

SyncFullSchemaPropertiesListResult

SyncFullSchemaTable

SyncFullSchemaTableColumn