Instance Failover Groups - List By Location
場所ごとにフェールオーバー グループをリストします。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2021-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
location
|
path | True |
string |
リソースが配置されているリージョンの名前。 |
resource
|
path | True |
string |
リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。 |
subscription
|
path | True |
string |
Azure サブスクリプションを識別するサブスクリプション ID。 |
api-version
|
query | True |
string |
要求で使用する API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
フェールオーバー グループが正常に取得されました。 |
|
Other Status Codes |
エラー応答: ***
|
例
List failover group
要求のサンプル
応答のサンプル
{
"value": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test",
"name": "failover-group-test",
"type": "Microsoft.Sql/locations/instanceFailoverGroups",
"properties": {
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 480
},
"readOnlyEndpoint": {
"failoverPolicy": "Disabled"
},
"replicationRole": "Primary",
"replicationState": "CATCH_UP",
"partnerRegions": [
{
"location": "Japan West",
"replicationRole": "Secondary"
}
],
"managedInstancePairs": [
{
"primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
"partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
}
]
}
},
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-1",
"name": "failover-group-test-1",
"type": "Microsoft.Sql/locations/instanceFailoverGroups",
"properties": {
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 480
},
"readOnlyEndpoint": {
"failoverPolicy": "Disabled"
},
"replicationRole": "Primary",
"replicationState": "CATCH_UP",
"partnerRegions": [
{
"location": "Japan West",
"replicationRole": "Secondary"
}
],
"managedInstancePairs": [
{
"primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance-1",
"partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance-1"
}
]
}
}
]
}
定義
名前 | 説明 |
---|---|
Instance |
インスタンス フェールオーバー グループ。 |
Instance |
インスタンス フェールオーバー グループの一覧。 |
Instance |
フェールオーバー グループ インスタンスの読み取り専用エンドポイント。 |
Instance |
フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。 |
Instance |
フェールオーバー グループ インスタンスのローカル レプリケーション ロール。 |
Managed |
フェールオーバー グループ内のマネージド インスタンスのペア。 |
Partner |
フェールオーバー グループのパートナー リージョン情報。 |
Read |
フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。 |
Read |
フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。 |
InstanceFailoverGroup
インスタンス フェールオーバー グループ。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの ID |
name |
string |
リソース名。 |
properties.managedInstancePairs |
フェールオーバー グループ内のマネージド インスタンスペアの一覧。 |
|
properties.partnerRegions |
フェールオーバー グループのパートナー リージョン情報。 |
|
properties.readOnlyEndpoint |
フェールオーバー グループ インスタンスの読み取り専用エンドポイント。 |
|
properties.readWriteEndpoint |
フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。 |
|
properties.replicationRole |
フェールオーバー グループ インスタンスのローカル レプリケーション ロール。 |
|
properties.replicationState |
string |
フェールオーバー グループ インスタンスのレプリケーション状態。 |
type |
string |
リソースの種類。 |
InstanceFailoverGroupListResult
インスタンス フェールオーバー グループの一覧。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
結果の次のページを取得するためのリンク。 |
value |
結果の配列。 |
InstanceFailoverGroupReadOnlyEndpoint
フェールオーバー グループ インスタンスの読み取り専用エンドポイント。
名前 | 型 | 説明 |
---|---|---|
failoverPolicy |
フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。 |
InstanceFailoverGroupReadWriteEndpoint
フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。
名前 | 型 | 説明 |
---|---|---|
failoverPolicy |
フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。 |
|
failoverWithDataLossGracePeriodMinutes |
integer |
データ損失によるフェールオーバー前の猶予期間は、読み取り/書き込みエンドポイントに対して試行されます。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。 |
InstanceFailoverGroupReplicationRole
フェールオーバー グループ インスタンスのローカル レプリケーション ロール。
名前 | 型 | 説明 |
---|---|---|
Primary |
string |
|
Secondary |
string |
ManagedInstancePairInfo
フェールオーバー グループ内のマネージド インスタンスのペア。
名前 | 型 | 説明 |
---|---|---|
partnerManagedInstanceId |
string |
ペアのパートナー Managed Instanceの ID。 |
primaryManagedInstanceId |
string |
ペアのプライマリ Managed Instanceの ID。 |
PartnerRegionInfo
フェールオーバー グループのパートナー リージョン情報。
名前 | 型 | 説明 |
---|---|---|
location |
string |
パートナー マネージド インスタンスの地理的な場所。 |
replicationRole |
パートナー マネージド インスタンスのレプリケーション ロール。 |
ReadOnlyEndpointFailoverPolicy
フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ReadWriteEndpointFailoverPolicy
フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が [自動] の場合は、failoverWithDataLossGracePeriodMinutes が必要です。
名前 | 型 | 説明 |
---|---|---|
Automatic |
string |
|
Manual |
string |