Replication Links - Failover Allow Data Loss

サービス:: SQL Database

API バージョン:: 2023-08-01

現在のプライマリサーバーからこのサーバーにフェールオーバーすると、データが失われます。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/forceFailoverAllowDataLoss?api-version=2023-08-01

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
linkId	path	True	string	レプリケーションリンクの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	ReplicationLink	正常にフェールオーバーされました。
202 Accepted		フェールオーバー操作が進行中です。ヘッダー Location: string
Other Status Codes	ErrorResponse	エラー応答: *** 400 ReplicationLinksReplicationLinkNameIsInvalid - レプリケーションリンク名は有効な guid にする必要があります。 400 GeoReplicationDatabaseNotSecondary - この操作では、データベースがレプリケーションターゲットであることが想定されます。 400 ReplicationLinksReplicationLinkTypeIsInvalid - LinkType が無効です。有効な値は STANDBY と GEO です。 400 ReplicationLinksCreateIsNotSupported - レプリケーションリンクの作成はサポートされていません。 400 LedgerNoDropLink - データベースで台帳ダイジェストアップロードが有効になっているため、geo レプリケーションを停止できません。台帳ダイジェストのアップロードを無効にして、操作を再試行します。 400 InvalidServerName - 無効なサーバー名が指定されました。 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。 400 TokenTooLong - 指定されたトークンが長すぎます。 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合 400 InvalidServerName - 無効なサーバー名が指定されました。 400 GeoReplicationDatabaseNotSecondary - この操作では、データベースがレプリケーションターゲットであることが想定されます。 400 CannotUseTrailingWhitespacesInDatabaseName - データベース名の検証に失敗しました。 400 IncorrectReplicationLinkState - この操作では、データベースがレプリケーションリンクで予期された状態であることが想定されます。 400 PlannedFailoverTimedOut - ユーザーが計画されたフェールオーバーを呼び出し、パートナー管理サービスに問い合わせようとしているときにタイムアウトしました。 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - preferredEnclaveType プロパティの異なる値を使用するデータベースでは、geo レプリケーションの構成はサポートされていません。 '{0}' サーバー上のプライマリ '{1}' データベースは '{2}' preferredEnclaveType を使用しますが、'{3}' サーバー上のセカンダリ '{4}' データベースに指定された preferredEnclaveType は '{5}' です。 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - PreferredEnclaveType が異なるプライマリデータベースとセカンダリデータベース間の計画されたフェールオーバーは、仮想化ベースのセキュリティ (VBS) エンクレーブではサポートされていません。 400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 409 UpdateSloInProgress - SLO 更新の進行中に、ユーザーが互換性のない操作を開始しようとしました。 409 InvalidOperationForDatabaseNotInReplicationRelationship - レプリケーション関係にないデータベースに対してレプリケーション操作が実行されました。 409 ConflictingSystemOperationInProgress - データベースでシステムメンテナンス操作が進行中であり、それ以上の操作が完了するまで待機する必要があります。 409 DuplicateGeoDrRelation - データベースは既にレプリケーション関係にあります。これは重複する要求です。 409 GeoReplicationCannotBecomePrimaryDuringUndo - ユーザーが geo リンクをフェールオーバーまたは強制終了しようとしましたが、セカンダリが物理的に一貫性がないため、プライマリロールを入力できない状態です。 409 ManagementServiceDatabaseBusy - データベース '{0}' は別の操作でビジー状態です。後で操作を試してください。 409 FailoverGroupAlreadySetup - geo レプリケーションリンクはフェールオーバーグループの一部であるため、操作を実行できません。個別に終了またはフェールオーバーするには、グループからデータベースを削除する必要があります。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

名前

型

説明

200 OK

ReplicationLink

正常にフェールオーバーされました。

202 Accepted

フェールオーバー操作が進行中です。

ヘッダー

Location: string

Other Status Codes

ErrorResponse

エラー応答: ***

400 ReplicationLinksReplicationLinkNameIsInvalid - レプリケーションリンク名は有効な guid にする必要があります。
400 GeoReplicationDatabaseNotSecondary - この操作では、データベースがレプリケーションターゲットであることが想定されます。
400 ReplicationLinksReplicationLinkTypeIsInvalid - LinkType が無効です。有効な値は STANDBY と GEO です。
400 ReplicationLinksCreateIsNotSupported - レプリケーションリンクの作成はサポートされていません。
400 LedgerNoDropLink - データベースで台帳ダイジェストアップロードが有効になっているため、geo レプリケーションを停止できません。台帳ダイジェストのアップロードを無効にして、操作を再試行します。
400 InvalidServerName - 無効なサーバー名が指定されました。
400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。
400 TokenTooLong - 指定されたトークンが長すぎます。
400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合
400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合
400 InvalidServerName - 無効なサーバー名が指定されました。
400 GeoReplicationDatabaseNotSecondary - この操作では、データベースがレプリケーションターゲットであることが想定されます。
400 CannotUseTrailingWhitespacesInDatabaseName - データベース名の検証に失敗しました。
400 IncorrectReplicationLinkState - この操作では、データベースがレプリケーションリンクで予期された状態であることが想定されます。
400 PlannedFailoverTimedOut - ユーザーが計画されたフェールオーバーを呼び出し、パートナー管理サービスに問い合わせようとしているときにタイムアウトしました。
400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - preferredEnclaveType プロパティの異なる値を使用するデータベースでは、geo レプリケーションの構成はサポートされていません。 '{0}' サーバー上のプライマリ '{1}' データベースは '{2}' preferredEnclaveType を使用しますが、'{3}' サーバー上のセカンダリ '{4}' データベースに指定された preferredEnclaveType は '{5}' です。
400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - PreferredEnclaveType が異なるプライマリデータベースとセカンダリデータベース間の計画されたフェールオーバーは、仮想化ベースのセキュリティ (VBS) エンクレーブではサポートされていません。
400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。
400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。
404 OperationIdNotFound - Id を持つ操作が存在しません。
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 OperationIdNotFound - Id を持つ操作が存在しません。
404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。
409 CannotCancelOperation - 管理操作が取り消すことができない状態です。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
409 UpdateSloInProgress - SLO 更新の進行中に、ユーザーが互換性のない操作を開始しようとしました。
409 InvalidOperationForDatabaseNotInReplicationRelationship - レプリケーション関係にないデータベースに対してレプリケーション操作が実行されました。
409 ConflictingSystemOperationInProgress - データベースでシステムメンテナンス操作が進行中であり、それ以上の操作が完了するまで待機する必要があります。
409 DuplicateGeoDrRelation - データベースは既にレプリケーション関係にあります。これは重複する要求です。
409 GeoReplicationCannotBecomePrimaryDuringUndo - ユーザーが geo リンクをフェールオーバーまたは強制終了しようとしましたが、セカンダリが物理的に一貫性がないため、プライマリロールを入力できない状態です。
409 ManagementServiceDatabaseBusy - データベース '{0}' は別の操作でビジー状態です。後で操作を試してください。
409 FailoverGroupAlreadySetup - geo レプリケーションリンクはフェールオーバーグループの一部であるため、操作を実行できません。個別に終了またはフェールオーバーするには、グループからデータベースを削除する必要があります。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Forced failover of a replication link

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb/forceFailoverAllowDataLoss?api-version=2023-08-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/stable/2023-08-01/examples/ReplicationLinkFailoverAllowDataLoss.json
// this example is just showing the usage of "ReplicationLinks_FailoverAllowDataLoss" 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 SqlServerDatabaseReplicationLinkResource created on azure
// for more information of creating SqlServerDatabaseReplicationLinkResource, please refer to the document of SqlServerDatabaseReplicationLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "gamma-db";
string linkId = "4891ca10-ebd0-47d7-9182-c722651780fb";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.FailoverAllowDataLossAsync(WaitUntil.Completed);
SqlServerDatabaseReplicationLinkResource 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
SqlServerDatabaseReplicationLinkData 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

{
  "properties": {
    "partnerServer": "testsvr",
    "partnerDatabase": "gamma-db",
    "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db",
    "partnerLocation": "Japan East",
    "role": "Primary",
    "partnerRole": "Secondary",
    "replicationMode": "ASYNC",
    "startTime": "2018-06-21T08:12:43.783Z",
    "percentComplete": 100,
    "replicationState": "CATCH_UP",
    "isTerminationAllowed": true,
    "linkType": "GEO"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb",
  "name": "4891ca10-ebd0-47d7-9182-c722651780fb"
}

状態コード:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/replicationLinksOperationResults/replicationlink-group-test-3?api-version=2022-05-01-preview

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ReplicationLink	レプリケーションリンク。
ReplicationLinkType	リンクの種類 (GEO、名前付き、スタンバイ)。更新操作は NAMED をサポートしていません。
ReplicationRole	ローカルレプリケーションロール。
ReplicationState	レプリケーションの状態 (保留中、シード処理、キャッチアップ、中断)。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ReplicationLink

Object

レプリケーションリンク。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.isTerminationAllowed	boolean	ユーザーが現在リンクの終了を許可されているかどうかを示します。
properties.linkType	ReplicationLinkType	リンクの種類 (GEO、名前付き、スタンバイ)。更新操作は NAMED をサポートしていません。
properties.partnerDatabase	string	リソースパートナーデータベース。
properties.partnerDatabaseId	string	リソースパートナーデータベース ID。
properties.partnerLocation	string	リソースパートナーの場所。
properties.partnerRole	ReplicationRole	パートナーレプリケーションロール。
properties.partnerServer	string	リソースパートナーサーバー。
properties.percentComplete	integer (int32)	リンクのシード処理完了率。
properties.replicationMode	string	レプリケーションモード。
properties.replicationState	ReplicationState	レプリケーションの状態 (保留中、シード処理、キャッチアップ、中断)。
properties.role	ReplicationRole	ローカルレプリケーションロール。
properties.startTime	string (date-time)	リンクが作成された時刻。
type	string	リソースの種類。

ReplicationLinkType

列挙

リンクの種類 (GEO、名前付き、スタンバイ)。更新操作は NAMED をサポートしていません。

値	説明
GEO
NAMED
STANDBY

ReplicationRole

列挙

ローカルレプリケーションロール。

値	説明
Primary
Secondary
NonReadableSecondary
Source
Copy

ReplicationState

列挙

レプリケーションの状態 (保留中、シード処理、キャッチアップ、中断)。

値	説明
PENDING
SEEDING
CATCH_UP
SUSPENDED

次の方法で共有

Replication Links - Failover Allow Data Loss

URI パラメーター

応答

例

Forced failover of a replication link

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReplicationLink

ReplicationLinkType

ReplicationRole

ReplicationState