Compartilhar via

Sync Members - Get

  • Referência
Serviço:
SQL Database
Versão da API:
2023-08-01

Obtém um membro de sincronização.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}?api-version=2023-08-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 na API do Azure Resource Manager ou no portal.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string

A ID da assinatura que identifica uma assinatura do Azure.
syncGroupName
 path True

string

O nome do grupo de sincronização no qual o membro de sincronização está hospedado.
syncMemberName
 path True

string

O nome do membro de sincronização.
api-version
 query True

string

A versão da API a ser usada para a solicitação.

Respostas

Nome Tipo Description
200 OK

SyncMember

Recuperou com êxito o membro de sincronização especificado.
Other Status Codes

ErrorResponse

Respostas de erro: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest – O corpo da solicitação de grupo de sincronização criar ou atualizar está vazio.

  • 400 InvalidSyncMemberCreateOrUpdateRequest - O corpo da solicitação do membro de criação ou atualização está vazio.

  • 400 InvalidSyncAgentCreateOrUpdateRequest - O corpo da solicitação do agente 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. Esse campo pode conter letras, números, traços e sublinhados.

  • 400 InvalidSyncMemberName – O nome do Membro de Sincronização é inválido. Esse 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 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 InvalidSyncMember – O membro de sincronização é inválido.

  • 400 InvalidSyncAgent – O agente de sincronização é inválido.

  • 400 CannotCreateSyncMemberDueToQuotaExceeded - Não é possível criar um membro de sincronização devido à cota excedida.

  • 400 SyncOperation_DuplicateSyncMemberDrop - O membro 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_DwInSyncGroup – Não é possível usar a edição 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 tem suporte.

  • 400 SyncOperation_InvalidCredential – a credencial do banco de dados é inválida.

  • 400 InvalidSyncMetadataDatabase – O banco de dados de metadados de sincronização é inválido.

  • 404 ResourceNotFound – O recurso solicitado não foi encontrado.

  • 404 SubscriptionNotFound – A assinatura solicitada não foi encontrada.

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

  • 409 SyncOperation_DuplicateSyncMemberName – Não é possível criar membro de sincronização porque o membro de sincronização com o mesmo nome já existe.

  • 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

  • 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

Get a sync member

Solicitação de exemplo

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/syncMembers/syncmembercrud-4879?api-version=2023-08-01

Resposta de exemplo

Código de status:
200 
{
  "properties": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}

Definições

Nome Description
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
SyncDirection

Direção de sincronização do membro de sincronização.
SyncMember

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

Tipo de banco de dados do membro de sincronização.
SyncMemberState

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

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

SyncDirection

Enumeração

Direção de sincronização do membro de sincronização.

Valor Description
Bidirectional
OneWayHubToMember
OneWayMemberToHub

SyncMember

Objeto

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

Nome Tipo Description
id

string

ID do recurso.
name

string

Nome do recurso.
properties.databaseName

string

Nome do banco de dados membro no membro de sincronização.
properties.databaseType

SyncMemberDbType

Tipo de banco de dados do membro de sincronização.
properties.password

string

Senha do banco de dados membro no membro de sincronização.
properties.privateEndpointName

string

Nome do ponto de extremidade privado do membro de sincronização se a conexão de link privado estiver habilitada para membros de sincronização no Azure.
properties.serverName

string

Nome do servidor do banco de dados membro no membro de sincronização
properties.sqlServerDatabaseId

string (uuid)

ID do banco de dados do SQL Server do membro de sincronização.
properties.syncAgentId

string

ID do recurso ARM do agente de sincronização no membro de sincronização.
properties.syncDirection

SyncDirection

Direção de sincronização do membro de sincronização.
properties.syncMemberAzureDatabaseResourceId

string

ID de recurso arm do banco de dados lógico membro de sincronização para membros de sincronização no Azure.
properties.syncState

SyncMemberState

Estado de sincronização do membro de sincronização.
properties.usePrivateLinkConnection

boolean

Se deve usar a conexão de link privado.
properties.userName

string

Nome de usuário do banco de dados membro no membro de sincronização.
type

string

Tipo de recurso.

SyncMemberDbType

Enumeração

Tipo de banco de dados do membro de sincronização.

Valor Description
AzureSqlDatabase
SqlServerDatabase

SyncMemberState

Enumeração

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

Valor Description
DeProvisionFailed
DeProvisioned
DeProvisioning
DisabledBackupRestore
DisabledTombstoneCleanup
ProvisionFailed
Provisioned
Provisioning
ReprovisionFailed
Reprovisioning
SyncCancelled
SyncCancelling
SyncFailed
SyncInProgress
SyncSucceeded
SyncSucceededWithWarnings
UnProvisioned
UnReprovisioned