Distributed Availability Groups - Failover

Service:

SQL Database

Version d’API:

2025-01-01

Effectue le type de basculement demandé dans ce groupe de disponibilité distribué.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
distributedAvailabilityGroupName	path	True	string	Nom du groupe de disponibilité distribué.
managedInstanceName	path	True	string	Nom de l’instance managée.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
failoverType	True	FailoverType	Le type de basculement peut être ForcedAllowDataLoss ou Planifié.

Réponses

Nom	Type	Description
200 OK	DistributedAvailabilityGroup	Opération Azure terminée avec succès.
202 Accepted		Exploitation des ressources acceptée. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Failover a distributed availability group.

Exemple de requête

HTTP

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

{
  "failoverType": "ForcedAllowDataLoss"
}

Java

import com.azure.resourcemanager.sql.models.DistributedAvailabilityGroupsFailoverRequest;
import com.azure.resourcemanager.sql.models.FailoverType;

/**
 * Samples for DistributedAvailabilityGroups Failover.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsFailover.json
     */
    /**
     * Sample code: Failover a distributed availability group.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void failoverADistributedAvailabilityGroup(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDistributedAvailabilityGroups().failover("testrg", "testcl", "dag",
            new DistributedAvailabilityGroupsFailoverRequest().withFailoverType(FailoverType.FORCED_ALLOW_DATA_LOSS),
            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_failover.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.begin_failover(
        resource_group_name="testrg",
        managed_instance_name="testcl",
        distributed_availability_group_name="dag",
        parameters={"failoverType": "ForcedAllowDataLoss"},
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsFailover.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 performs requested failover type in this distributed availability group.
 *
 * @summary performs requested failover type in this distributed availability group.
 * x-ms-original-file: 2025-01-01/DistributedAvailabilityGroupsFailover.json
 */
async function failoverADistributedAvailabilityGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.distributedAvailabilityGroups.failover("testrg", "testcl", "dag", {
    failoverType: "ForcedAllowDataLoss",
  });
  console.log(result);
}

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/DistributedAvailabilityGroupsFailover.json
// this example is just showing the usage of "DistributedAvailabilityGroups_Failover" 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 SqlDistributedAvailabilityGroupResource created on azure
// for more information of creating SqlDistributedAvailabilityGroupResource, please refer to the document of SqlDistributedAvailabilityGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
string managedInstanceName = "testcl";
string distributedAvailabilityGroupName = "dag";
ResourceIdentifier sqlDistributedAvailabilityGroupResourceId = SqlDistributedAvailabilityGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, distributedAvailabilityGroupName);
SqlDistributedAvailabilityGroupResource sqlDistributedAvailabilityGroup = client.GetSqlDistributedAvailabilityGroupResource(sqlDistributedAvailabilityGroupResourceId);

// invoke the operation
DistributedAvailabilityGroupsFailoverContent content = new DistributedAvailabilityGroupsFailoverContent(SqlServerFailoverType.ForcedAllowDataLoss);
ArmOperation<SqlDistributedAvailabilityGroupResource> lro = await sqlDistributedAvailabilityGroup.FailoverAsync(WaitUntil.Completed, content);
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

Exemple de réponse

Code d’état:

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": "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"
  }
}

Code d’état:

202

Location: https://management.azure.com/subscriptions/f2669dff-5f08-45dd-b857-b2a60b72cdc9/providers/Microsoft.Sql/locations/westus/distributedAvailabilityGroupsOperationResults/00000000-1111-2222-3333-444444444444?api-version=2023-08-01-preview

Définitions

Nom	Description
CertificateInfo	Informations sur le certificat
createdByType	Type d’identité qui a créé la ressource.
DistributedAvailabilityGroup	Groupe de disponibilité distribué entre la boîte et l’instance Sql Managed Instance.
DistributedAvailabilityGroupDatabase	Informations spécifiques à la base de données
DistributedAvailabilityGroupsFailoverRequest	Basculement de groupe de disponibilité distribué.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
FailoverModeType	Le mode basculement liant peut être manuel s’il est destiné à être utilisé pour le basculement bidirectionnel avec un SQL Server supporté, ou aucun pour le basculement unidirectionnel vers Azure.
FailoverType	Le type de basculement peut être ForcedAllowDataLoss ou Planifié.
LinkRole	Rôle de lien côté serveur SQL
ReplicaConnectedState	Lier l’état connecté
ReplicaSynchronizationHealth	État d’intégrité du lien
ReplicationModeType	Mode de réplication du lien
SeedingModeType	Mode d’amorçage de base de données : peut être automatique (par défaut) ou Manuel pour les scénarios pris en charge.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CertificateInfo

Objet

Informations sur le certificat

Nom	Type	Description
certificateName	string	Nom du certificat
expiryDate	string (date-time)	Date d’expiration du certificat

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Objet

Groupe de disponibilité distribué entre la boîte et l’instance Sql Managed Instance.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.databases	DistributedAvailabilityGroupDatabase[]	Bases de données dans le groupe de disponibilité distribué
properties.distributedAvailabilityGroupId	string (uuid)	ID du groupe de disponibilité distribué
properties.distributedAvailabilityGroupName	string	Nom du groupe de disponibilité distribué
properties.failoverMode	FailoverModeType	Le mode basculement liant peut être manuel s’il est destiné à être utilisé pour le basculement bidirectionnel avec un SQL Server supporté, ou aucun pour le basculement unidirectionnel vers Azure.
properties.instanceAvailabilityGroupName	string	Nom du groupe de disponibilité côté instance managée
properties.instanceLinkRole	LinkRole	Rôle de lien côté instance managée
properties.partnerAvailabilityGroupName	string	Nom du groupe de disponibilité côté serveur SQL
properties.partnerEndpoint	string	Point de terminaison côté serveur SQL - NOM IP ou DNS résolvable
properties.partnerLinkRole	LinkRole	Rôle de lien côté serveur SQL
properties.replicationMode	ReplicationModeType	Mode de réplication du lien
properties.seedingMode	SeedingModeType	Mode d’amorçage de base de données : peut être automatique (par défaut) ou Manuel pour les scénarios pris en charge.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

DistributedAvailabilityGroupDatabase

Objet

Informations spécifiques à la base de données

Nom	Type	Description
connectedState	ReplicaConnectedState	Lier l’état connecté
databaseName	string	Nom de la base de données dans le lien
instanceRedoReplicationLagSeconds	integer (int32)	Délai de reprise lorsque le côté lien Managed Instance est principal
instanceReplicaId	string (uuid)	ID de réplica d’instance managée
instanceSendReplicationLagSeconds	integer (int32)	Latence de réplication lorsque le côté lien Managed Instance est principal
lastBackupLsn	string	Dernière sauvegarde LSN
lastBackupTime	string (date-time)	Heure de la dernière sauvegarde LSN
lastCommitLsn	string	Dernière validation LSN
lastCommitTime	string (date-time)	Heure de la dernière validation LSN
lastHardenedLsn	string	Dernier LSN renforcé
lastHardenedTime	string (date-time)	Dernière heure LSN renforcée
lastReceivedLsn	string	Dernier LSN reçu
lastReceivedTime	string (date-time)	Dernière heure LSN reçue
lastSentLsn	string	Dernier LSN envoyé
lastSentTime	string (date-time)	Dernière heure LSN envoyée
mostRecentLinkError	string	Description de l’erreur de connexion de lien la plus récente
partnerAuthCertValidity	CertificateInfo	Validité du certificat SQL Server
partnerReplicaId	string (uuid)	ID de réplica SQL Server
replicaState	string	État actuel du lien
seedingProgress	string	Progression de l’amorçage
synchronizationHealth	ReplicaSynchronizationHealth	État d’intégrité du lien

DistributedAvailabilityGroupsFailoverRequest

Objet

Basculement de groupe de disponibilité distribué.

Nom	Type	Description
failoverType	FailoverType	Le type de basculement peut être ForcedAllowDataLoss ou Planifié.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

FailoverModeType

Énumération

Le mode basculement liant peut être manuel s’il est destiné à être utilisé pour le basculement bidirectionnel avec un SQL Server supporté, ou aucun pour le basculement unidirectionnel vers Azure.

Valeur	Description
None	Aucun
Manual	Manuel

FailoverType

Énumération

Le type de basculement peut être ForcedAllowDataLoss ou Planifié.

Valeur	Description
ForcedAllowDataLoss	ForcedAllowDataLoss
Planned	Planifié

LinkRole

Énumération

Rôle de lien côté serveur SQL

Valeur	Description
Primary	Primaire
Secondary	Secondaire

ReplicaConnectedState

Énumération

Lier l’état connecté

Valeur	Description
DISCONNECTED	DÉCONNECTÉ
CONNECTED	CONNECTED

ReplicaSynchronizationHealth

Énumération

État d’intégrité du lien

Valeur	Description
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	SAIN

ReplicationModeType

Énumération

Mode de réplication du lien

Valeur	Description
Async	Asynchrone
Sync	Synchronisation

SeedingModeType

Énumération

Mode d’amorçage de base de données : peut être automatique (par défaut) ou Manuel pour les scénarios pris en charge.

Valeur	Description
Automatic	Automatique
Manual	Manuel

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.