Distributed Availability Groups - Create Or Update

Dienst:

SQL Database

API-Version:

2025-01-01

Erstellt eine verteilte Verfügbarkeitsgruppe zwischen SQL On-Prem und SQL verwaltete Instanz.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
distributedAvailabilityGroupName	path	True	string	Der Name der verteilten Verfügbarkeitsgruppe.
managedInstanceName	path	True	string	Der Name der verwalteten Instanz.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.databases	DistributedAvailabilityGroupDatabase[]	Datenbanken in der Gruppe "Verteilte Verfügbarkeit"
properties.failoverMode	FailoverModeType	Der Link-Failover-Modus – kann manuell sein, wenn er für Zwei-Wege-Failover mit einem unterstützten SQL Server gedacht ist, oder None für Einweg-Failover zu Azure.
properties.instanceAvailabilityGroupName	string	Name der gruppenseitigen Verfügbarkeitsgruppe für verwaltete Instanzen
properties.instanceLinkRole	LinkRole	Rolle für verwaltete Instanzseitige Verknüpfungen
properties.partnerAvailabilityGroupName	string	Name der sql serverseitigen Verfügbarkeitsgruppe
properties.partnerEndpoint	string	SQL Server-Seitenendpunkt – IP- oder DNS-Auflösungsname
properties.replicationMode	ReplicationModeType	Replikationsmodus des Links
properties.seedingMode	SeedingModeType	Datenbanksamenmodus – kann für unterstützte Szenarien automatisch (Standard) oder manuell sein.

Antworten

Name	Typ	Beschreibung
200 OK	DistributedAvailabilityGroup	Die Aktualisierungsoperation der Ressource 'DistributedAvailabilityGroup' war erfolgreich
201 Created	DistributedAvailabilityGroup	Resource 'DistributedAvailabilityGroup'-Erstellungsoperation erfolgreich Header Location: string Retry-After: integer
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create a distributed availability group with all properties.

Create a distributed availability group with minimal properties.

Create a distributed availability group with all properties.

Beispielanforderung

HTTP

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

{
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

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/DistributedAvailabilityGroupsCreateMax.json
// this example is just showing the usage of "DistributedAvailabilityGroups_CreateOrUpdate" 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";
SqlDistributedAvailabilityGroupData data = new SqlDistributedAvailabilityGroupData
{
    PartnerAvailabilityGroupName = "BoxLocalAg1",
    PartnerEndpoint = "TCP://SERVER:7022",
    InstanceLinkRole = SqlServerSideLinkRole.Primary,
    InstanceAvailabilityGroupName = "testcl",
    FailoverMode = SqlServerFailoverModeType.None,
    SeedingMode = SeedingModeType.Automatic,
    Databases = {new DistributedAvailabilityGroupDatabase
    {
    DatabaseName = "testdb",
    }},
};
ArmOperation<SqlDistributedAvailabilityGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, distributedAvailabilityGroupName, data);
SqlDistributedAvailabilityGroupResource result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:

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": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

Statuscode:

201

{
  "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": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

Statuscode:

202

Create a distributed availability group with minimal properties.

Beispielanforderung

HTTP

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

{
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "instanceAvailabilityGroupName": "testcl",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022"
  }
}

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/DistributedAvailabilityGroupsCreateMin.json
// this example is just showing the usage of "DistributedAvailabilityGroups_CreateOrUpdate" 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";
SqlDistributedAvailabilityGroupData data = new SqlDistributedAvailabilityGroupData
{
    PartnerAvailabilityGroupName = "BoxLocalAg1",
    PartnerEndpoint = "TCP://SERVER:7022",
    InstanceAvailabilityGroupName = "testcl",
    Databases = {new DistributedAvailabilityGroupDatabase
    {
    DatabaseName = "testdb",
    }},
};
ArmOperation<SqlDistributedAvailabilityGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, distributedAvailabilityGroupName, data);
SqlDistributedAvailabilityGroupResource result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:

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": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Secondary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

Statuscode:

201

{
  "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": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Secondary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

Statuscode:

202

Definitionen

Name	Beschreibung
CertificateInfo	Zertifikatinformationen
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DistributedAvailabilityGroup	Verteilte Verfügbarkeitsgruppe zwischen Box und SQL verwaltete Instanz.
DistributedAvailabilityGroupDatabase	Datenbankspezifische Informationen
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
FailoverModeType	Der Link-Failover-Modus – kann manuell sein, wenn er für Zwei-Wege-Failover mit einem unterstützten SQL Server gedacht ist, oder None für Einweg-Failover zu Azure.
LinkRole	SQL Server-Querlinkrolle
ReplicaConnectedState	Verbindungsstatus
ReplicaSynchronizationHealth	Integritätszustand der Verknüpfung
ReplicationModeType	Replikationsmodus des Links
SeedingModeType	Datenbanksamenmodus – kann für unterstützte Szenarien automatisch (Standard) oder manuell sein.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CertificateInfo

Objekt

Zertifikatinformationen

Name	Typ	Beschreibung
certificateName	string	Der Zertifikatname
expiryDate	string (date-time)	Das Ablaufdatum des Zertifikats

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Objekt

Verteilte Verfügbarkeitsgruppe zwischen Box und SQL verwaltete Instanz.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.databases	DistributedAvailabilityGroupDatabase[]	Datenbanken in der Gruppe "Verteilte Verfügbarkeit"
properties.distributedAvailabilityGroupId	string (uuid)	ID der Verteilten Verfügbarkeitsgruppe
properties.distributedAvailabilityGroupName	string	Name der Verteilten Verfügbarkeitsgruppe
properties.failoverMode	FailoverModeType	Der Link-Failover-Modus – kann manuell sein, wenn er für Zwei-Wege-Failover mit einem unterstützten SQL Server gedacht ist, oder None für Einweg-Failover zu Azure.
properties.instanceAvailabilityGroupName	string	Name der gruppenseitigen Verfügbarkeitsgruppe für verwaltete Instanzen
properties.instanceLinkRole	LinkRole	Rolle für verwaltete Instanzseitige Verknüpfungen
properties.partnerAvailabilityGroupName	string	Name der sql serverseitigen Verfügbarkeitsgruppe
properties.partnerEndpoint	string	SQL Server-Seitenendpunkt – IP- oder DNS-Auflösungsname
properties.partnerLinkRole	LinkRole	SQL Server-Querlinkrolle
properties.replicationMode	ReplicationModeType	Replikationsmodus des Links
properties.seedingMode	SeedingModeType	Datenbanksamenmodus – kann für unterstützte Szenarien automatisch (Standard) oder manuell sein.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

DistributedAvailabilityGroupDatabase

Objekt

Datenbankspezifische Informationen

Name	Typ	Beschreibung
connectedState	ReplicaConnectedState	Verbindungsstatus
databaseName	string	Der Name der Datenbank im Link
instanceRedoReplicationLagSeconds	integer (int32)	Redo-Lag, wenn die verwaltete Instanz-Linkseite primär ist
instanceReplicaId	string (uuid)	Replikat-ID der verwalteten Instanz
instanceSendReplicationLagSeconds	integer (int32)	Replikationsverzögerung, wenn die verwaltete Instanz-Linkseite primär ist
lastBackupLsn	string	Letzter Sicherungs-LSN
lastBackupTime	string (date-time)	Letzte Sicherungs-LSN-Zeit
lastCommitLsn	string	Letzter Commit für LSN
lastCommitTime	string (date-time)	Letzter Commit für LSN-Zeit
lastHardenedLsn	string	Letzte gehärtete LSN
lastHardenedTime	string (date-time)	Letzte gehärtete LSN-Zeit
lastReceivedLsn	string	Zuletzt empfangener LSN
lastReceivedTime	string (date-time)	Letzte empfangene LSN-Zeit
lastSentLsn	string	Zuletzt gesendeter LSN
lastSentTime	string (date-time)	Letzte gesendete LSN-Zeit
mostRecentLinkError	string	Fehlerbeschreibung der letzten Verknüpfungsverbindung
partnerAuthCertValidity	CertificateInfo	Gültigkeit des SQL Server-Zertifikats
partnerReplicaId	string (uuid)	SQL Server-Replikat-ID
replicaState	string	Aktueller Verknüpfungsstatus
seedingProgress	string	Seeding-Fortschritt
synchronizationHealth	ReplicaSynchronizationHealth	Integritätszustand der Verknüpfung

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FailoverModeType

Enumeration

Der Link-Failover-Modus – kann manuell sein, wenn er für Zwei-Wege-Failover mit einem unterstützten SQL Server gedacht ist, oder None für Einweg-Failover zu Azure.

Wert	Beschreibung
None	Nichts
Manual	Manuell

LinkRole

Enumeration

SQL Server-Querlinkrolle

Wert	Beschreibung
Primary	Primär
Secondary	Secondary

ReplicaConnectedState

Enumeration

Verbindungsstatus

Wert	Beschreibung
DISCONNECTED	GETRENNT
CONNECTED	CONNECTED

ReplicaSynchronizationHealth

Enumeration

Integritätszustand der Verknüpfung

Wert	Beschreibung
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	GESUND

ReplicationModeType

Enumeration

Replikationsmodus des Links

Wert	Beschreibung
Async	Async
Sync	Synchronisieren

SeedingModeType

Enumeration

Datenbanksamenmodus – kann für unterstützte Szenarien automatisch (Standard) oder manuell sein.

Wert	Beschreibung
Automatic	Automatisch
Manual	Manuell

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.