Distributed Availability Groups - Failover

서비스:: SQL Database

API 버전:: 2025-01-01

이 분산 가용성 그룹에서 요청된 장애 조치(failover) 유형을 수행합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
distributedAvailabilityGroupName	path	True	string	분산 가용성 그룹 이름입니다.
managedInstanceName	path	True	string	관리되는 인스턴스의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
failoverType	True	FailoverType	장애 조치(failover) 유형은 ForcedAllowDataLoss 또는 Planned일 수 있습니다.

응답

Name	형식	Description
200 OK	DistributedAvailabilityGroup	Azure 운영이 성공적으로 완료되었습니다.
202 Accepted		자원 작업이 허용되었습니다. 헤더 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

Name

형식

Description

200 OK

DistributedAvailabilityGroup

Azure 운영이 성공적으로 완료되었습니다.

202 Accepted

자원 작업이 허용되었습니다.

헤더

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Failover a distributed availability group.

샘플 요청

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


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

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

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

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

샘플 응답

상태 코드:: 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"
  }
}

상태 코드:: 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

정의

Name	Description
CertificateInfo	인증서 정보
createdByType	리소스를 만든 ID의 형식입니다.
DistributedAvailabilityGroup	Box와 Sql Managed Instance 간의 분산 가용성 그룹입니다.
DistributedAvailabilityGroupDatabase	데이터베이스 관련 정보
DistributedAvailabilityGroupsFailoverRequest	분산 가용성 그룹 장애 조치(failover).
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
FailoverModeType	링크 페일오버 모드는 지원되는 SQL Server와의 양방향 페일오버를 위해 수동 모드로 사용할 수 있으며, Azure로의 일방향 페일오버를 위한 None(없음) 모드가 될 수 있습니다.
FailoverType	장애 조치(failover) 유형은 ForcedAllowDataLoss 또는 Planned일 수 있습니다.
LinkRole	SQL Server 쪽 링크 역할
ReplicaConnectedState	연결된 상태 연결
ReplicaSynchronizationHealth	링크 상태
ReplicationModeType	링크의 복제 모드
SeedingModeType	데이터베이스 시드 모드 – 지원되는 시나리오의 경우 자동(기본값) 또는 수동일 수 있습니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

CertificateInfo

Object

인증서 정보

Name	형식	Description
certificateName	string	인증서 이름
expiryDate	string (date-time)	인증서 만료 날짜

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key