Sync Agents - List Linked Databases

Serviço:

SQL Database

Versão da API:

2021-11-01

Listas bancos de dados vinculados a um agente de sincronização.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases?api-version=2021-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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 no qual o agente de sincronização está hospedado.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
syncAgentName	path	True	string	O nome do agente 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	SyncAgentLinkedDatabaseListResult	Bancos de dados do SQL Server vinculados ao agente de sincronização recuperados com êxito.
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 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 master lógica na sincronização de dados. 400 CannotDeleteInUseSyncAgent – Não é possível excluir o agente de sincronização porque ele é usado pelo membro de sincronização. 400 InvalidSyncAgent – O agente de sincronização é inválido. 400 InvalidSyncMetadataDatabase – O banco de dados de metadados 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. 409 SyncOperation_AgentAlreadyExists – O agente de sincronização com o mesmo nome já existe. 409 SyncOperation_AgentIdAlreadyExists – O agente de sincronização com a mesma ID já existe.

Exemplos

Get sync agent linked databases

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases?api-version=2021-11-01

Java

/**
 * Samples for SyncAgents ListLinkedDatabases.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGetLinkedDatabases.json
     */
    /**
     * Sample code: Get sync agent linked databases.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSyncAgentLinkedDatabases(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().listLinkedDatabases("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187", 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 de exemplo

Código de status:

200

{
  "value": [
    {
      "properties": {
        "databaseType": "SqlServerDatabase",
        "databaseId": "55555555-6666-7777-8888-999999999999",
        "description": "",
        "serverName": "DummySqlServer",
        "databaseName": "DummySqlServerDb",
        "userName": "DummyUser"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases/55555555-6666-7777-8888-999999999999"
    }
  ]
}

Definições

Nome	Description
SyncAgentLinkedDatabase	Um banco de dados vinculado do agente de sincronização de banco de dados SQL do Azure.
SyncAgentLinkedDatabaseListResult	Uma lista de bancos de dados vinculados do agente de sincronização.
SyncMemberDbType	Tipo do banco de dados vinculado do agente de sincronização.

SyncAgentLinkedDatabase

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

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.databaseId	string	Id do banco de dados vinculado do agente de sincronização.
properties.databaseName	string	Nome do banco de dados do banco de dados vinculado do agente de sincronização.
properties.databaseType	SyncMemberDbType	Tipo do banco de dados vinculado do agente de sincronização.
properties.description	string	Descrição do banco de dados vinculado do agente de sincronização.
properties.serverName	string	Nome do servidor do banco de dados vinculado do agente de sincronização.
properties.userName	string	Nome de usuário do banco de dados vinculado do agente de sincronização.
type	string	Tipo de recurso.

SyncAgentLinkedDatabaseListResult

Uma lista de bancos de dados vinculados do agente de sincronização.

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

SyncMemberDbType

Tipo do banco de dados vinculado do agente de sincronização.

Nome	Tipo	Description
AzureSqlDatabase	string
SqlServerDatabase	string