Failover Groups - Create Or Update

サービス:
SQL Database
API バージョン:
2025-01-01

フェールオーバー グループを作成または更新します。

PUT 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.partnerServers True

PartnerInfo[]

フェールオーバー グループのパートナー サーバー情報の一覧。
properties.readWriteEndpoint True

FailoverGroupReadWriteEndpoint

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

string[] (arm-id)

フェールオーバー グループ内のデータベースの一覧。
properties.readOnlyEndpoint

FailoverGroupReadOnlyEndpoint

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

FailoverGroupDatabasesSecondaryType

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

object

リソース タグ。

応答

名前 型 説明
200 OK

FailoverGroup

リソース「FailoverGroup」更新操作が成功しました
201 Created

FailoverGroup

リソース「FailoverGroup」作成操作成功

ヘッダー

  • Location: string
  • Retry-After: integer
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 ユーザー アカウントを偽装する

例

Create failover group
Create failover group with standby secondary database on partner server.

Create failover group

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3?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",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    }
  }
}

応答のサンプル

状態コード:
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",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}
状態コード:
201 
{
  "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",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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": 480
    },
    "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

Create failover group with standby secondary database on partner server.

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3?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",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "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",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}
状態コード:
201 
{
  "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",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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": 480
    },
    "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

フェールオーバー グループ インスタンスのローカル レプリケーション ロール。
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

セカンダリ

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 の種類。