Failover Groups - Update

サービス:

SQL Database

API バージョン:

2021-11-01

フェールオーバー グループを更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
failoverGroupName	path	True	string	フェールオーバー グループの名前。
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
serverName	path	True	string	フェールオーバー グループを含むサーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

名前	型	説明
properties.databases	string[]	フェールオーバー グループ内のデータベースの一覧。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	フェールオーバー グループ インスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。
tags	object	リソース タグ。

応答

名前	型	説明
200 OK	FailoverGroup	フェールオーバー グループが正常に更新されました。
202 Accepted		同意
Other Status Codes		エラー応答: *** 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - 指定されたデータベース ID が適切に構築されていないデータベース リソース ID。 適切な書式設定の例については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - フェールオーバー グループの作成または更新要求本文の指定されたパートナー フィールドが空または無効です。 このフィールドの有効な値を指定してください。 適切に書式設定された要求の例については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - 指定された 1 つ以上のパートナー サーバーが既にフェールオーバー グループの一部です。 プライマリ サーバーと指定されたすべてのパートナー サーバーが一意であることを確認してください。 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - 指定された 1 つ以上のデータベースがフェールオーバー グループのプライマリ サーバーに存在しません。 すべてのデータベースがプライマリ サーバー上に存在することを確認してください。 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - フェールオーバー グループのパートナー サーバーは 1 つだけサポートされています。 必要に応じて要求を変更してください。 有効な要求の例については、次を参照してください。 https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - 要求の作成または更新には readWriteEndpoint フィールドが必要です。 400 FailoverGroupCreateOrUpdateRequestInvalid - フェールオーバー グループの作成または更新要求本文が空または無効です。 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - セカンダリ サーバーでは、フェールオーバー グループの変更は許可されません。 プライマリ サーバーで要求を実行します。 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - 読み取り/書き込みエンドポイントの猶予期間値は負でない必要があります。 400 FailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - フェールオーバー グループの猶予期間値は、最小猶予期間 '{0}' 分以上である必要があります 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - 読み取り/書き込みエンドポイントでフェールオーバー ポリシー自動が選択されている場合は、プロパティ failoverWithDataLossGracePeriodMinutes を指定する必要があります。 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - 作成要求または更新要求には、読み取り/書き込みエンドポイントの failoverPolicy フィールドが必要です。 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - 読み取り/書き込みエンドポイントにフェールオーバー ポリシー Manual が選択されている場合は、猶予期間値を指定しないでください。 要求から削除してください。 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - フェールオーバー グループの作成または更新要求本文は、読み取り専用プロパティ '{0}' を変更しないでください。 400 FailoverGroupFailoverRequestOnPrimary - フェールオーバー 要求は、フェールオーバー グループのセカンダリ サーバーで開始する必要があります。 400 FailoverGroupPartnerServerFromDifferentSubscription - フェールオーバー グループのプライマリ サーバーとパートナー サーバーは、異なるサブスクリプションから取得されます。 フェールオーバー グループのサーバーのクロス サブスクリプションは許可されません。 400 InvalidAddSecondaryPermission - 指定されたサーバーにセカンダリを追加するための十分なアクセス許可がありません。 400 InvalidSku - ユーザーが無効な SKU を指定しました。 400 ServerNotFound - 要求されたサーバーが見つかりませんでした。 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベース エディションで無効になっている機能を使用しようとしました。 400 TokenTooLong - 指定されたトークンが長すぎます。 400 InvalidTargetSubregion - 読み取り不可能なセカンダリのターゲット サーバーが DR ペアの Azure リージョンにありません。 400 PartnerServerNotCompatible - ユーザーが SAWA V1 サーバーから Sterling サーバーにデータベースをコピーしようとしています。その逆も同様です。 400 IncorrectReplicationLinkState - この操作では、データベースがレプリケーション リンクで予期された状態であることが想定されます。 400 ResourcePoolNotFound - 指定されたエラスティック プールが、指定された論理サーバーに存在しません。 400 AzureKeyVaultKeyDisabled - Azure Key Vault キーが無効になっているため、サーバーで操作を完了できませんでした。 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault キーの有効期限が無効であるため、操作を完了できませんでした。 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri が null または空であるため、操作を完了できませんでした。 400 AzureKeyVaultNoServerIdentity - サーバー ID が正しく構成されていません。 400 AzureKeyVaultInvalidUri - Azure Key Vault からの無効な応答。 有効な Azure Key Vault URI を使用してください。 400 AzureKeyVaultMissingPermissions - サーバーに Azure Key Vaultに必要なアクセス許可がありません。 400 SecurityAzureKeyVaultInvalidKeyName - サーバー キー名が無効なため、操作を完了できませんでした。 400 PlannedFailoverTimedOutForDatabase - ユーザーが計画フェールオーバー呼び出し、タイムアウトし、特定のデータベースが原因と思われます。 400 PlannedFailoverTimedOut - ユーザーが計画フェールオーバー呼び出し、パートナー管理サービスに問い合わせようとしているときにタイムアウトしました。 400 AdalGenericError - Azure Active Directory エラーが発生したため、操作を完了できませんでした。 400 AdalServicePrincipalNotFound - Azure Active Directory ライブラリのサービス プリンシパルが見つからないというエラーが発生したため、操作を完了できませんでした。 400 AzureKeyVaultMalformedVaultUri - 指定されたKey Vault URI が無効です。 400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。 400 InvalidFailoverGroupRegion - フェールオーバー グループで指定されたサーバーは、分離を提供するために異なるリージョンに存在する必要があります。 400 FailoverGroupDoesNotExist - フェールオーバー グループがサーバー上に存在しません。 400 FailoverGroupNotSecondary - フェールオーバー グループ内のプライマリ サーバーからフェールオーバーを開始できません。 400 InvalidServerName - 無効なサーバー名が指定されています。 400 DatabaseInFailoverGroupNotPrimary - データベースの GeoDR リンクは既に存在しますが、そのロールは "プライマリ" ではないか、連続コピー リンクではありません。 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault プリンシパル証明書の有効期限が切れているため、操作を完了できませんでした。 400 UnableToCreateFailoverGroupDueToTableAuditing - テーブル監査が有効になっているサーバーに対してフェールオーバー グループを作成できません。 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。 400 UnableToAddDbWithTableAuditingToFailoverGroup - テーブル監査が有効になっているデータベースには、フェールオーバー グループ エンドポイントを介してアクセスできません。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 指定されたKey Vault URI が無効です。 400 KeyMaterialNotFoundOnRemoteServer - リモート サーバーは、TDE 保護機能として使用されるキー マテリアルにアクセスできません。 400 LimitOfFailoverGroupsPerServerExceeded - 新しいフェールオーバー グループの作成は、サーバーあたりのフェールオーバー グループの許可数を超えます。 400 SameKeyUriNotFoundOnRemoteServer - セカンダリ サーバーには、キーの自動ローテーションが有効になっているプライマリ サーバーの暗号化保護機能と同じキー コンテナーのキー マテリアルがありません。 400 AzureKeyVaultRsaKeyNotSupported - 提供されたキー コンテナーでは、サポートされていない RSA キー サイズまたはキーの種類が使用されます。 サポートされている RSA キー サイズは 2048 または 3072 で、キーの種類は RSA または RSA-HSM です。 400 SameKeyMaterialNotFoundOnRemoteServer - セカンダリ サーバーには、プライマリ サーバーの暗号化保護機能のキー マテリアルがありません。 400 GeoReplicationDatabaseNotSecondary - この操作では、データベースがレプリケーション ターゲットであることが想定されます。 400 GeoReplicaLimitReached - レプリカごとのレプリケーションの制限に達しました。 400 FailoverGroupWithVirtualNetworkRulesNotSupported - 自動フェールオーバー ポリシーで構成されたフェールオーバー グループは、現在、仮想ネットワーク ファイアウォール規則で構成されたサーバーではサポートされていません。 手動フェールオーバー ポリシーを使用してフェールオーバー グループを構成してください。 400 UnableToResolveRemoteServer - サーバー名または DNS 接続の問題が無効なため、リモート パートナー サーバー名を解決できませんでした。 400 RemoteDatabaseCopyPermission - 指定されたサーバーにデータベース コピーを作成するための十分な権限がありません。 400 SecurityAzureKeyVaultGeoChainError - Azure Key Vault (BYOK) を使用して Transparent Data Encryption を有効にする場合、セカンダリのセカンダリ (チェーンと呼ばれるプロセス) の作成はサポートされません。 400 FailoverGroupCreateOrUpdatePartiallySucceeded - 一部のデータベースを追加または削除できませんでした。 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 ServerNotInSubscription - 指定されたサブスクリプションに指定されたサーバーが存在しません。 404 SourceDatabaseNotFound - ソース データベースが存在しません。 405 UnsupportedReplicationOperation - サポートされていないレプリケーション操作がデータベースで開始されました。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 409 ConflictingServerOperation - サーバーに対する操作が現在進行中です。 409 SubscriptionDisabled - サブスクリプションが無効になっています。 409 ConflictingSystemOperationInProgress - データベースでシステム メンテナンス操作が進行中であり、それ以上の操作が完了するまで待機する必要があります。 409 GeoReplicationCannotBecomePrimaryDuringUndo - セカンダリが物理的に一貫していない可能性があり、プライマリ ロールを入力できない状態にある間に、ユーザーが geo リンクをフェールオーバーまたは強制終了しようとしました。 409 ServerKeyNameAlreadyExists - サーバー キーは既にサーバーに存在します。 409 ServerKeyUriAlreadyExists - サーバー キー URI はサーバー上に既に存在します。 "409 ServerKeyDoesNotExists - The server key does not exist. " (409 ServerKeyDoesNotExists - サーバー キーは存在しません。) 409 UpdateSloInProgress - SLO 更新の進行中に、ユーザーが互換性のない操作を開始しようとしました。 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault キー名が存在しないため、操作を完了できませんでした。 409 AzureKeyVaultKeyInUse - キーは現在サーバーによって使用されています。 409 FailoverGroupAlreadyExists - フェールオーバー グループは、特定のサーバーに既に存在します。 別のフェールオーバー グループ名を使用してください。 409 FailoverGroupBusy - フェールオーバー グループが別の操作でビジー状態です。 409 DatabaseBelongsToOtherFailoverGroup - データベースは他のフェールオーバー グループに属しており、このグループの一部と見なすことはできません。 409 DatabaseBeingAddedToFailoverGroup - データベースは現在フェールオーバー グループに追加されています。お客様は、この操作が完了して削除の問題が発生するまで待機する必要があります。 409 DatabaseBeingRemovedFromFailoverGroup - データベースは現在フェールオーバー グループから削除されています。お客様は、この操作が完了して追加が発行されるまで待機する必要があります。 409 FailoverGroupDnsRecordInUse - 要求されたエンドポイントに重複する DNS レコードが存在します。 409 InvalidFailoverGroupName - 無効なフェールオーバー グループ名が指定されました。 409 InvalidOperationForDatabaseNotInReplicationRelationship - レプリケーション のシード処理操作が、既にレプリケーション関係にあるデータベースに対して実行されました。 409 InvalidDatabaseStateForOperation - この操作は、現在のレプリケーション状態のデータベースでは許可されません。 409 DuplicateGeoDrRelation - データベースは既にレプリケーション関係にあります。 これは重複する要求です。 409 RemoteDatabaseExists - 宛先データベース名は既に移行先サーバーに存在します。 409 FailoverGroupUnableToPerformGroupOperationOnDatabases - フェールオーバー グループとの間で追加/削除するデータベースの一覧には、操作の完了を妨げているエラーが含まれています。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースで処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースで処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作をやり直してください。 503 TooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 503 TooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 503 AzureKeyVaultConnectionFailed - Azure Key Vaultへの接続が失敗したため、サーバーで操作を完了できませんでした 503 AzureKeyVaultGenericConnectionError - Key Vault情報を取得しようとしたときにエラーが発生したため、操作を完了できませんでした。 503 DatabaseUnavailable - データベースが使用できないため、操作に失敗しました。 504 RequestTimeout - サービス要求が許可されたタイムアウトを超えました。

例

Update failover group

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2021-11-01

{
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ]
  }
}

Java

import com.azure.resourcemanager.sql.models.FailoverGroupReadWriteEndpoint;
import com.azure.resourcemanager.sql.models.FailoverGroupUpdate;
import com.azure.resourcemanager.sql.models.ReadWriteEndpointFailoverPolicy;
import java.util.Arrays;

/**
 * Samples for FailoverGroups Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/FailoverGroupUpdate.json
     */
    /**
     * Sample code: Update failover group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getFailoverGroups()
            .update("Default", "failover-group-primary-server", "failover-group-test-1", new FailoverGroupUpdate()
                .withReadWriteEndpoint(
                    new FailoverGroupReadWriteEndpoint().withFailoverPolicy(ReadWriteEndpointFailoverPolicy.AUTOMATIC)
                        .withFailoverWithDataLossGracePeriodMinutes(120))
                .withDatabases(Arrays.asList(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1")),
                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

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "location": "Japan East",
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ]
  }
}

状態コード:

202

定義

名前	説明
FailoverGroup	フェールオーバー グループ。
FailoverGroupReadOnlyEndpoint	フェールオーバー グループ インスタンスの読み取り専用エンドポイント。
FailoverGroupReadWriteEndpoint	フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。
FailoverGroupReplicationRole	フェールオーバー グループ インスタンスのローカル レプリケーション ロール。
FailoverGroupUpdate	フェールオーバー グループの更新要求。
PartnerInfo	フェールオーバー グループのパートナー サーバー情報。
ReadOnlyEndpointFailoverPolicy	フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。
ReadWriteEndpointFailoverPolicy	フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。

FailoverGroup

フェールオーバー グループ。

名前	型	説明
id	string	リソースの ID
location	string	リソースの場所。
name	string	リソース名。
properties.databases	string[]	フェールオーバー グループ内のデータベースの一覧。
properties.partnerServers	PartnerInfo[]	フェールオーバー グループのパートナー サーバー情報の一覧。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	フェールオーバー グループ インスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。
properties.replicationRole	FailoverGroupReplicationRole	フェールオーバー グループ インスタンスのローカル レプリケーション ロール。
properties.replicationState	string	フェールオーバー グループ インスタンスのレプリケーション状態。
tags	object	リソース タグ。
type	string	リソースの種類。

FailoverGroupReadOnlyEndpoint

フェールオーバー グループ インスタンスの読み取り専用エンドポイント。

名前	型	説明
failoverPolicy	ReadOnlyEndpointFailoverPolicy	フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。

FailoverGroupReadWriteEndpoint

フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。

名前	型	説明
failoverPolicy	ReadWriteEndpointFailoverPolicy	フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。
failoverWithDataLossGracePeriodMinutes	integer	データ損失によるフェールオーバー前の猶予期間は、読み取り/書き込みエンドポイントに対して試行されます。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。

FailoverGroupReplicationRole

フェールオーバー グループ インスタンスのローカル レプリケーション ロール。

名前	型	説明
Primary	string
Secondary	string

FailoverGroupUpdate

フェールオーバー グループの更新要求。

名前	型	説明
properties.databases	string[]	フェールオーバー グループ内のデータベースの一覧。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	フェールオーバー グループ インスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。
tags	object	リソース タグ。

PartnerInfo

フェールオーバー グループのパートナー サーバー情報。

名前	型	説明
id	string	パートナー サーバーのリソース識別子。
location	string	パートナー サーバーの地理的な場所。
replicationRole	FailoverGroupReplicationRole	パートナー サーバーのレプリケーション ロール。

ReadOnlyEndpointFailoverPolicy

フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。

名前	型	説明
Disabled	string
Enabled	string

ReadWriteEndpointFailoverPolicy

フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。

名前	型	説明
Automatic	string
Manual	string