Distributed Availability Groups - List By Instance

Serviço:

SQL Database

Versão da API:

2025-01-01

Obtém uma lista de grupos de disponibilidade distribuídos em instância.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups?api-version=2025-01-01

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
managedInstanceName	path	True	string	O nome da instância gerenciada.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	DistributedAvailabilityGroupsListResult	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Lists all distributed availability groups in instance.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups?api-version=2025-01-01

Java

/**
 * Samples for DistributedAvailabilityGroups ListByInstance.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsListByInstance.json
     */
    /**
     * Sample code: Lists all distributed availability groups in instance.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        listsAllDistributedAvailabilityGroupsInInstance(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDistributedAvailabilityGroups().listByInstance("testrg", "testcl",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python distributed_availability_groups_list_by_instance.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.distributed_availability_groups.list_by_instance(
        resource_group_name="testrg",
        managed_instance_name="testcl",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsListByInstance.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a list of a distributed availability groups in instance.
 *
 * @summary gets a list of a distributed availability groups in instance.
 * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsListByInstance.json
 */
async function listsAllDistributedAvailabilityGroupsInInstance() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.distributedAvailabilityGroups.listByInstance(
    "testrg",
    "testcl",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

dotnet

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/SQL/stable/2025-01-01/examples/DistributedAvailabilityGroupsListByInstance.json
// this example is just showing the usage of "DistributedAvailabilityGroups_ListByInstance" 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://learn.microsoft.com/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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testcl";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this SqlDistributedAvailabilityGroupResource
SqlDistributedAvailabilityGroupCollection collection = managedInstance.GetSqlDistributedAvailabilityGroups();

// invoke the operation and iterate over the result
await foreach (SqlDistributedAvailabilityGroupResource item in collection.GetAllAsync())
{
    // the variable item 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
    SqlDistributedAvailabilityGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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": [
    {
      "name": "dag",
      "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
      "properties": {
        "databases": [
          {
            "connectedState": "CONNECTED",
            "databaseName": "testdb",
            "instanceRedoReplicationLagSeconds": 1,
            "instanceReplicaId": "4713ed91-1e8c-497d-9bd4-d8a3935ae49a",
            "instanceSendReplicationLagSeconds": 1,
            "lastBackupLsn": "71000009405700001",
            "lastBackupTime": "2023-08-01T00:00:00Z",
            "lastCommitLsn": "71000009407900004",
            "lastCommitTime": "2023-08-01T00:00:00Z",
            "lastHardenedLsn": "71000009408100001",
            "lastHardenedTime": "2023-08-01T00:00:00Z",
            "lastReceivedLsn": "71000009407900001",
            "lastReceivedTime": "2023-08-01T00:00:00Z",
            "partnerReplicaId": "8ffa9723-a1ec-4323-b929-c4aedee3894b",
            "replicaState": "Catchup",
            "synchronizationHealth": "HEALTHY"
          }
        ],
        "distributedAvailabilityGroupId": "c856cff5-a6fe-418e-8894-17799cc20f5d",
        "distributedAvailabilityGroupName": "dag",
        "failoverMode": "None",
        "instanceAvailabilityGroupName": "testcl",
        "instanceLinkRole": "Primary",
        "partnerAvailabilityGroupName": "BoxLocalAg1",
        "partnerEndpoint": "TCP://SERVER:7022",
        "partnerLinkRole": "Secondary",
        "replicationMode": "Async",
        "seedingMode": "Automatic"
      }
    },
    {
      "name": "dag2",
      "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag2",
      "properties": {
        "databases": [
          {
            "connectedState": "CONNECTED",
            "databaseName": "testdb2",
            "instanceReplicaId": "81608df4-0840-4219-b3ae-9cc46be9dae9",
            "lastBackupLsn": "71000009405700001",
            "lastBackupTime": "2023-08-01T00:00:00Z",
            "lastCommitLsn": "71000009407900004",
            "lastCommitTime": "2023-08-01T00:00:00Z",
            "lastHardenedLsn": "71000009408100001",
            "lastHardenedTime": "2023-08-01T00:00:00Z",
            "lastReceivedLsn": "71000009407900001",
            "lastReceivedTime": "2023-08-01T00:00:00Z",
            "partnerReplicaId": "57bc3421-e77a-4fdc-8a62-af105c4b1e38",
            "replicaState": "Seeding",
            "seedingProgress": "80%",
            "synchronizationHealth": "HEALTHY"
          }
        ],
        "distributedAvailabilityGroupId": "8a52d869-c17e-4546-ab03-e038569e672a",
        "distributedAvailabilityGroupName": "dag2",
        "instanceAvailabilityGroupName": "testcl2",
        "instanceLinkRole": "Secondary",
        "partnerAvailabilityGroupName": "BoxLocalAg2",
        "partnerEndpoint": "TCP://SERVER:7022",
        "partnerLinkRole": "Primary",
        "replicationMode": "Async"
      }
    }
  ]
}

Definições

Name	Descrição
CertificateInfo	Informações do certificado
createdByType	O tipo de identidade que criou o recurso.
DistributedAvailabilityGroup	Grupo de disponibilidade distribuído entre a caixa e a Sql Managed Instance.
DistributedAvailabilityGroupDatabase	Informações específicas da base de dados
DistributedAvailabilityGroupsListResult	Uma lista de grupos de disponibilidade distribuídos em instância.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FailoverModeType	O modo de failover de ligação - pode ser Manual se destinado a ser usado para failover bidirecional com um SQL Server suportado, ou None para failover unidirecional para o Azure.
LinkRole	Função de link lateral do SQL Server
ReplicaConnectedState	Estado conectado do link
ReplicaSynchronizationHealth	Estado de integridade do link
ReplicationModeType	Modo de replicação do link
SeedingModeType	Modo de propagação de banco de dados – pode ser Automático (padrão) ou Manual para cenários suportados.
systemData	Metadados referentes à criação e última modificação do recurso.

CertificateInfo

Object

Informações do certificado

Name	Tipo	Descrição
certificateName	string	O nome do certificado
expiryDate	string (date-time)	Data de validade do certificado

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Object

Grupo de disponibilidade distribuído entre a caixa e a Sql Managed Instance.

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.databases	DistributedAvailabilityGroupDatabase[]	Bancos de dados no grupo de disponibilidade distribuída
properties.distributedAvailabilityGroupId	string (uuid)	ID do grupo de disponibilidade distribuída
properties.distributedAvailabilityGroupName	string	Nome do grupo de disponibilidade distribuída
properties.failoverMode	FailoverModeType	O modo de failover de ligação - pode ser Manual se destinado a ser usado para failover bidirecional com um SQL Server suportado, ou None para failover unidirecional para o Azure.
properties.instanceAvailabilityGroupName	string	Nome do grupo de disponibilidade do lado da instância gerenciada
properties.instanceLinkRole	LinkRole	Função de link lateral da instância gerenciada
properties.partnerAvailabilityGroupName	string	Nome do grupo de disponibilidade do lado do servidor SQL
properties.partnerEndpoint	string	Ponto de extremidade do lado do servidor SQL - Nome resolúvel por IP ou DNS
properties.partnerLinkRole	LinkRole	Função de link lateral do SQL Server
properties.replicationMode	ReplicationModeType	Modo de replicação do link
properties.seedingMode	SeedingModeType	Modo de propagação de banco de dados – pode ser Automático (padrão) ou Manual para cenários suportados.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

DistributedAvailabilityGroupDatabase

Object

Informações específicas da base de dados

Name	Tipo	Descrição
connectedState	ReplicaConnectedState	Estado conectado do link
databaseName	string	O nome do banco de dados no link
instanceRedoReplicationLagSeconds	integer (int32)	Redo lag quando o lado da ligação Managed Instance é principal
instanceReplicaId	string (uuid)	ID da réplica da instância gerenciada
instanceSendReplicationLagSeconds	integer (int32)	Atraso de replicação quando o lado da ligação Managed Instance é o principal
lastBackupLsn	string	Último LSN de backup
lastBackupTime	string (date-time)	Última hora LSN de backup
lastCommitLsn	string	Última confirmação LSN
lastCommitTime	string (date-time)	Última confirmação da hora LSN
lastHardenedLsn	string	Última LSN endurecida
lastHardenedTime	string (date-time)	Última hora LSN endurecida
lastReceivedLsn	string	Última LSN recebida
lastReceivedTime	string (date-time)	Última hora LSN recebida
lastSentLsn	string	LSN enviado pela última vez
lastSentTime	string (date-time)	Última hora LSN enviada
mostRecentLinkError	string	A descrição do erro de conexão de link mais recente
partnerAuthCertValidity	CertificateInfo	Validade do certificado do SQL Server
partnerReplicaId	string (uuid)	ID da réplica do servidor SQL
replicaState	string	Estado atual do link
seedingProgress	string	Progresso da semeadura
synchronizationHealth	ReplicaSynchronizationHealth	Estado de integridade do link

DistributedAvailabilityGroupsListResult

Object

Uma lista de grupos de disponibilidade distribuídos em instância.

Name	Tipo	Descrição
nextLink	string	Link para recuperar a próxima página de resultados.
value	DistributedAvailabilityGroup[]	Matriz de resultados.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
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 alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

FailoverModeType

Enumeração

O modo de failover de ligação - pode ser Manual se destinado a ser usado para failover bidirecional com um SQL Server suportado, ou None para failover unidirecional para o Azure.

Valor	Descrição
None	Nenhum
Manual	Manual

LinkRole

Enumeração

Função de link lateral do SQL Server

Valor	Descrição
Primary	Primário
Secondary	Secundária

ReplicaConnectedState

Enumeração

Estado conectado do link

Valor	Descrição
DISCONNECTED	DISCONNECTED
CONNECTED	LIGADO

ReplicaSynchronizationHealth

Enumeração

Estado de integridade do link

Valor	Descrição
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	SAUDÁVEL

ReplicationModeType

Enumeração

Modo de replicação do link

Valor	Descrição
Async	Assíncrono
Sync	Sincronização

SeedingModeType

Enumeração

Modo de propagação de banco de dados – pode ser Automático (padrão) ou Manual para cenários suportados.

Valor	Descrição
Automatic	Automático
Manual	Manual

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.