Failover Groups - Update

サービス:: SQL Database

API バージョン:: 2025-01-01

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

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

URI パラメーター

名前	/	必須	型	説明
failoverGroupName	path	True	string	フェールオーバーグループの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.databases	string[] (arm-id)	フェールオーバーグループ内のデータベースの一覧。
properties.partnerServers	PartnerInfo[]	フェールオーバーグループのパートナーサーバー情報の一覧。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	フェールオーバーグループインスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	フェールオーバーグループインスタンスの読み取り/書き込みエンドポイント。
properties.secondaryType	FailoverGroupDatabasesSecondaryType	パートナーサーバー上のデータベースのセカンダリの種類。
tags	object	リソースタグ。

応答

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

名前

型

説明

200 OK

FailoverGroup

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	ユーザーアカウントを偽装する

例

Add database to failover group with standby secondary on partner server.

Update failover group

Add database to failover group with standby secondary on partner server.

要求のサンプル

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=2025-01-01

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

応答のサンプル

状態コード:: 200

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

状態コード:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

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=2025-01-01

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

応答のサンプル

状態コード:: 200

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

状態コード:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FailoverGroup	フェールオーバーグループ。
FailoverGroupDatabasesSecondaryType	パートナーサーバー上のデータベースのセカンダリの種類。
FailoverGroupReadOnlyEndpoint	フェールオーバーグループインスタンスの読み取り専用エンドポイント。
FailoverGroupReadWriteEndpoint	フェールオーバーグループインスタンスの読み取り/書き込みエンドポイント。
FailoverGroupReplicationRole	フェールオーバーグループインスタンスのローカルレプリケーションロール。
FailoverGroupUpdate	フェールオーバーグループの更新要求。
PartnerInfo	フェールオーバーグループのパートナーサーバー情報。
ReadOnlyEndpointFailoverPolicy	フェールオーバーグループの読み取り専用エンドポイントのフェールオーバーポリシー。
ReadWriteEndpointFailoverPolicy	フェールオーバーグループの読み取り/書き込みエンドポイントのフェールオーバーポリシー。 failoverPolicy が自動の場合、failoverWithDataLossGracePeriodMinutes が必要です。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

FailoverGroup

Object

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

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	リソースの場所。
name	string	リソースの名前
properties.databases	string[] (arm-id)	フェールオーバーグループ内のデータベースの一覧。
properties.partnerServers	PartnerInfo[]	フェールオーバーグループのパートナーサーバー情報の一覧。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	フェールオーバーグループインスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	フェールオーバーグループインスタンスの読み取り/書き込みエンドポイント。
properties.replicationRole	FailoverGroupReplicationRole	フェールオーバーグループインスタンスのローカルレプリケーションロール。
properties.replicationState	string	フェールオーバーグループインスタンスのレプリケーション状態。
properties.secondaryType	FailoverGroupDatabasesSecondaryType	パートナーサーバー上のデータベースのセカンダリの種類。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの型。例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

FailoverGroupDatabasesSecondaryType

列挙

パートナーサーバー上のデータベースのセカンダリの種類。

値	説明
Geo	ジオ
Standby	スタンバイ

FailoverGroupReadOnlyEndpoint

Object

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

名前	型	説明
failoverPolicy	ReadOnlyEndpointFailoverPolicy	フェールオーバーグループの読み取り専用エンドポイントのフェールオーバーポリシー。
targetServer	string (arm-id)	読み取り専用エンドポイントが指すターゲットパートナーサーバー。

FailoverGroupReadWriteEndpoint

Object

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

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

FailoverGroupReplicationRole

列挙

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

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

FailoverGroupUpdate

Object

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

名前	型	説明
properties.databases	string[] (arm-id)	フェールオーバーグループ内のデータベースの一覧。
properties.partnerServers	PartnerInfo[]	フェールオーバーグループのパートナーサーバー情報の一覧。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	フェールオーバーグループインスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	フェールオーバーグループインスタンスの読み取り/書き込みエンドポイント。
properties.secondaryType	FailoverGroupDatabasesSecondaryType	パートナーサーバー上のデータベースのセカンダリの種類。
tags	object	リソースタグ。

PartnerInfo

Object

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

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

ReadOnlyEndpointFailoverPolicy

列挙

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

値	説明
Disabled	Disabled
Enabled	有効

ReadWriteEndpointFailoverPolicy

列挙

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

値	説明
Manual	手動
Automatic	自動

systemData

Object

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

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