Distributed Availability Groups - Get

Služba:: SQL Database

Verze rozhraní API:: 2025-01-01

Získá informace o distribuované skupině dostupnosti.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
distributedAvailabilityGroupName	path	True	string	Název distribuované skupiny dostupnosti.
managedInstanceName	path	True	string	Název spravované instance.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DistributedAvailabilityGroup	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Gets the distributed availability group info.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag?api-version=2025-01-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/SQL/stable/2025-01-01/examples/DistributedAvailabilityGroupsGet.json
// this example is just showing the usage of "DistributedAvailabilityGroups_Get" 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
string distributedAvailabilityGroupName = "dag";
NullableResponse<SqlDistributedAvailabilityGroupResource> response = await collection.GetIfExistsAsync(distributedAvailabilityGroupName);
SqlDistributedAvailabilityGroupResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Ukázková odpověď

Stavový kód:: 200

{
  "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": "Seeding",
        "seedingProgress": "80%",
        "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"
  }
}

Definice

Name	Description
CertificateInfo	Informace o certifikátu
createdByType	Typ identity, která prostředek vytvořila.
DistributedAvailabilityGroup	Distribuovaná skupina dostupnosti mezi boxem a SQL Managed Instance.
DistributedAvailabilityGroupDatabase	Informace specifické pro databázi
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
FailoverModeType	Režim přepnutí linku – může být manuální, pokud je určen pro obousměrné přehození s podporovaným SQL Server, nebo None pro jednosměrné přepnutí do Azure.
LinkRole	Role propojení na straně serveru SQL
ReplicaConnectedState	Propojení připojeného stavu
ReplicaSynchronizationHealth	Stav propojení
ReplicationModeType	Režim replikace propojení
SeedingModeType	Režim počátečního nastavení databáze – může být automatický (výchozí) nebo ruční pro podporované scénáře.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CertificateInfo

Objekt

Informace o certifikátu

Name	Typ	Description
certificateName	string	Název certifikátu
expiryDate	string (date-time)	Datum vypršení platnosti certifikátu

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Objekt

Distribuovaná skupina dostupnosti mezi boxem a SQL Managed Instance.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.databases	DistributedAvailabilityGroupDatabase[]	Databáze v distribuované skupině dostupnosti
properties.distributedAvailabilityGroupId	string (uuid)	ID distribuované skupiny dostupnosti
properties.distributedAvailabilityGroupName	string	Název distribuované skupiny dostupnosti
properties.failoverMode	FailoverModeType	Režim přepnutí linku – může být manuální, pokud je určen pro obousměrné přehození s podporovaným SQL Server, nebo None pro jednosměrné přepnutí do Azure.
properties.instanceAvailabilityGroupName	string	Název skupiny dostupnosti na straně spravované instance
properties.instanceLinkRole	LinkRole	Role propojení na straně spravované instance
properties.partnerAvailabilityGroupName	string	Název skupiny dostupnosti na straně SQL Serveru
properties.partnerEndpoint	string	Koncový bod na straně serveru SQL – IP adresa nebo název DNS, který lze přeložit
properties.partnerLinkRole	LinkRole	Role propojení na straně serveru SQL
properties.replicationMode	ReplicationModeType	Režim replikace propojení
properties.seedingMode	SeedingModeType	Režim počátečního nastavení databáze – může být automatický (výchozí) nebo ruční pro podporované scénáře.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například "Microsoft. Compute/virtualMachines" nebo "Microsoft. Úložiště/úložištěÚčty"

DistributedAvailabilityGroupDatabase

Objekt

Informace specifické pro databázi

Name	Typ	Description
connectedState	ReplicaConnectedState	Propojení připojeného stavu
databaseName	string	Název databáze v odkazu
instanceRedoReplicationLagSeconds	integer (int32)	Redo lag, když je primární Managed Instance link side
instanceReplicaId	string (uuid)	ID repliky spravované instance
instanceSendReplicationLagSeconds	integer (int32)	Replikační zpoždění, když je primární Managed Instance linková strana
lastBackupLsn	string	Poslední záloha LSN
lastBackupTime	string (date-time)	Čas poslední zálohy LSN
lastCommitLsn	string	Poslední potvrzení LSN
lastCommitTime	string (date-time)	Čas posledního potvrzení LSN
lastHardenedLsn	string	Poslední posílená služba LSN
lastHardenedTime	string (date-time)	Poslední posílená doba LSN
lastReceivedLsn	string	Poslední přijetí LSN
lastReceivedTime	string (date-time)	Čas posledního přijetí LSN
lastSentLsn	string	Naposledy odeslánO LSN
lastSentTime	string (date-time)	Čas posledního odeslání LSN
mostRecentLinkError	string	Popis poslední chyby připojení k propojení
partnerAuthCertValidity	CertificateInfo	Platnost certifikátu SQL Serveru
partnerReplicaId	string (uuid)	ID repliky SERVERU SQL
replicaState	string	Aktuální stav propojení
seedingProgress	string	Průběh seedingu
synchronizationHealth	ReplicaSynchronizationHealth	Stav propojení

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

FailoverModeType

Výčet

Režim přepnutí linku – může být manuální, pokud je určen pro obousměrné přehození s podporovaným SQL Server, nebo None pro jednosměrné přepnutí do Azure.

Hodnota	Description
None	None
Manual	Příručka

LinkRole

Výčet

Role propojení na straně serveru SQL

Hodnota	Description
Primary	Primary
Secondary	Secondary

ReplicaConnectedState

Výčet

Propojení připojeného stavu

Hodnota	Description
DISCONNECTED	DISCONNECTED
CONNECTED	PŘIPOJEN

ReplicaSynchronizationHealth

Výčet

Stav propojení

Hodnota	Description
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	ZDRAVÉ

ReplicationModeType

Výčet

Režim replikace propojení

Hodnota	Description
Async	Async
Sync	Synchronizace

SeedingModeType

Výčet

Režim počátečního nastavení databáze – může být automatický (výchozí) nebo ruční pro podporované scénáře.

Hodnota	Description
Automatic	Automatické
Manual	Příručka

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.