Distributed Availability Groups - Failover

サービス:

SQL Database

API バージョン:

2025-01-01

この分散型可用性グループで、要求されたフェールオーバーの種類を実行します。

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

URI パラメーター

名前	/	必須	型	説明
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 バージョン。

要求本文

名前	必須	型	説明
failoverType	True	FailoverType	フェールオーバーの種類は、ForcedAllowDataLoss または Planned です。

応答

名前	型	説明
200 OK	DistributedAvailabilityGroup	Azureの運用は無事に完了しました。
202 Accepted		リソース操作が受け入れられます。 ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Failover a distributed availability group.

要求のサンプル

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

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

応答のサンプル

状態コード:

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

定義

名前	説明
CertificateInfo	証明書情報
createdByType	リソースを作成した ID の種類。
DistributedAvailabilityGroup	BoxとSQL Managed Instance間の分散可用性グループ。
DistributedAvailabilityGroupDatabase	データベース固有の情報
DistributedAvailabilityGroupsFailoverRequest	分散型可用性グループのフェールオーバー。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FailoverModeType	リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。
FailoverType	フェールオーバーの種類は、ForcedAllowDataLoss または Planned です。
LinkRole	SQL サーバー側のリンクの役割
ReplicaConnectedState	リンク接続状態
ReplicaSynchronizationHealth	リンクの正常性状態
ReplicationModeType	リンクのレプリケーション モード
SeedingModeType	データベース シードモード – サポートされているシナリオでは、自動 (既定)、または手動にすることができます。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CertificateInfo

Object

証明書情報

名前	型	説明
certificateName	string	証明書名
expiryDate	string (date-time)	証明書の有効期限

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Object

BoxとSQL Managed Instance間の分散可用性グループ。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.databases	DistributedAvailabilityGroupDatabase[]	分散型可用性グループ内のデータベース
properties.distributedAvailabilityGroupId	string (uuid)	分散型可用性グループの ID
properties.distributedAvailabilityGroupName	string	分散型可用性グループの名前
properties.failoverMode	FailoverModeType	リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。
properties.instanceAvailabilityGroupName	string	マネージド インスタンス側の可用性グループ名
properties.instanceLinkRole	LinkRole	マネージド インスタンス側のリンク ロール
properties.partnerAvailabilityGroupName	string	SQL サーバー側の可用性グループ名
properties.partnerEndpoint	string	SQL サーバー側のエンドポイント - IP または DNS 解決可能な名前
properties.partnerLinkRole	LinkRole	SQL サーバー側のリンクの役割
properties.replicationMode	ReplicationModeType	リンクのレプリケーション モード
properties.seedingMode	SeedingModeType	データベース シードモード – サポートされているシナリオでは、自動 (既定)、または手動にすることができます。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

DistributedAvailabilityGroupDatabase

Object

データベース固有の情報

名前	型	説明
connectedState	ReplicaConnectedState	リンク接続状態
databaseName	string	リンク内のデータベースの名前
instanceRedoReplicationLagSeconds	integer (int32)	Managed Instanceリンク側がプライマリの場合、遅延を再実行してください
instanceReplicaId	string (uuid)	マネージド インスタンスのレプリカ ID
instanceSendReplicationLagSeconds	integer (int32)	Managed Instanceリンク側がプライマリの場合のレプリケーション遅延
lastBackupLsn	string	最終バックアップ LSN
lastBackupTime	string (date-time)	最終バックアップ LSN 時刻
lastCommitLsn	string	最後のコミット LSN
lastCommitTime	string (date-time)	最終コミット LSN 時刻
lastHardenedLsn	string	最後に強化された LSN
lastHardenedTime	string (date-time)	最後に強化された LSN 時間
lastReceivedLsn	string	最後に受信した LSN
lastReceivedTime	string (date-time)	最後に受信した LSN 時刻
lastSentLsn	string	最後に送信された LSN
lastSentTime	string (date-time)	最後に送信された LSN 時刻
mostRecentLinkError	string	最新のリンク接続エラーの説明
partnerAuthCertValidity	CertificateInfo	SQL Server 証明書の有効性
partnerReplicaId	string (uuid)	SQL Server レプリカ ID
replicaState	string	現在のリンクの状態
seedingProgress	string	シード処理の進行状況
synchronizationHealth	ReplicaSynchronizationHealth	リンクの正常性状態

DistributedAvailabilityGroupsFailoverRequest

Object

分散型可用性グループのフェールオーバー。

名前	型	説明
failoverType	FailoverType	フェールオーバーの種類は、ForcedAllowDataLoss または Planned です。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

FailoverModeType

列挙

リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。

値	説明
None	なし
Manual	手動

FailoverType

列挙

フェールオーバーの種類は、ForcedAllowDataLoss または Planned です。

値	説明
ForcedAllowDataLoss	ForcedAllowDataLoss
Planned	計画済み

LinkRole

列挙

SQL サーバー側のリンクの役割

値	説明
Primary	プライマリ
Secondary	セカンダリ

ReplicaConnectedState

列挙

リンク接続状態

値	説明
DISCONNECTED	切断
CONNECTED	CONNECTED

ReplicaSynchronizationHealth

列挙

リンクの正常性状態

値	説明
NOT_HEALTHY	NOT_HEALTHY
PARTIALLY_HEALTHY	PARTIALLY_HEALTHY
HEALTHY	健康

ReplicationModeType

列挙

リンクのレプリケーション モード

値	説明
Async	非同期
Sync	同期

SeedingModeType

列挙

データベース シードモード – サポートされているシナリオでは、自動 (既定)、または手動にすることができます。

値	説明
Automatic	自動
Manual	手動

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。