Instance Failover Groups - Get
フェールオーバー グループを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2023-08-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
failover
|
path | True |
string |
フェールオーバー グループの名前。 |
|
location
|
path | True |
string |
リソースが配置されているリージョンの名前。 |
|
resource
|
path | True |
string |
リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。 |
|
subscription
|
path | True |
string |
Azure サブスクリプションを識別するサブスクリプション ID。 |
|
api-version
|
query | True |
string |
要求に使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
指定したフェールオーバー グループが正常に取得されました。 |
|
| Other Status Codes |
エラー応答: ***
|
例
Get failover group
要求のサンプル
応答のサンプル
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
"name": "failover-group-test-3",
"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"
}
],
"secondaryType": "Geo"
}
}
定義
| 名前 | 説明 |
|---|---|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Instance |
インスタンス フェールオーバー グループ。 |
|
Instance |
フェールオーバー グループ インスタンスの読み取り専用エンドポイント。 |
|
Instance |
フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。 |
|
Instance |
フェールオーバー グループ インスタンスのローカル レプリケーション ロール。 |
|
Managed |
フェールオーバー グループ内のマネージド インスタンスのペア。 |
|
Partner |
フェールオーバー グループのパートナー リージョン情報。 |
|
Read |
フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。 |
|
Read |
フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が自動の場合、failoverWithDataLossGracePeriodMinutes が必要です。 |
|
Secondary |
geo セカンダリ インスタンスの種類。 インスタンスが DR オプションとしてのみ使用されている場合は、"スタンバイ" を設定します。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
InstanceFailoverGroup
インスタンス フェールオーバー グループ。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
リソース ID。 |
| name |
string |
リソース名。 |
| properties.managedInstancePairs |
フェールオーバー グループ内のマネージド インスタンス ペアの一覧。 |
|
| properties.partnerRegions |
フェールオーバー グループのパートナー リージョン情報。 |
|
| properties.readOnlyEndpoint |
フェールオーバー グループ インスタンスの読み取り専用エンドポイント。 |
|
| properties.readWriteEndpoint |
フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。 |
|
| properties.replicationRole |
フェールオーバー グループ インスタンスのローカル レプリケーション ロール。 |
|
| properties.replicationState |
string |
フェールオーバー グループ インスタンスのレプリケーション状態。 |
| properties.secondaryType |
geo セカンダリ インスタンスの種類。 インスタンスが DR オプションとしてのみ使用されている場合は、"スタンバイ" を設定します。 |
|
| type |
string |
リソースの種類。 |
InstanceFailoverGroupReadOnlyEndpoint
フェールオーバー グループ インスタンスの読み取り専用エンドポイント。
| 名前 | 型 | 説明 |
|---|---|---|
| failoverPolicy |
フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。 |
InstanceFailoverGroupReadWriteEndpoint
フェールオーバー グループ インスタンスの読み取り/書き込みエンドポイント。
| 名前 | 型 | 説明 |
|---|---|---|
| failoverPolicy |
フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が自動の場合、failoverWithDataLossGracePeriodMinutes が必要です。 |
|
| failoverWithDataLossGracePeriodMinutes |
integer (int32) |
読み取り/書き込みエンドポイントに対して、データ損失によるフェールオーバー前の猶予期間が試行されます。 failoverPolicy が自動の場合、failoverWithDataLossGracePeriodMinutes が必要です。 |
InstanceFailoverGroupReplicationRole
フェールオーバー グループ インスタンスのローカル レプリケーション ロール。
| 値 | 説明 |
|---|---|
| Primary | |
| Secondary |
ManagedInstancePairInfo
フェールオーバー グループ内のマネージド インスタンスのペア。
| 名前 | 型 | 説明 |
|---|---|---|
| partnerManagedInstanceId |
string |
ペアのパートナー マネージド インスタンスの ID。 |
| primaryManagedInstanceId |
string |
ペアのプライマリ マネージド インスタンスの ID。 |
PartnerRegionInfo
フェールオーバー グループのパートナー リージョン情報。
| 名前 | 型 | 説明 |
|---|---|---|
| location |
string |
パートナー マネージド インスタンスの地理的な場所。 |
| replicationRole |
パートナー マネージド インスタンスのレプリケーション ロール。 |
ReadOnlyEndpointFailoverPolicy
フェールオーバー グループの読み取り専用エンドポイントのフェールオーバー ポリシー。
| 値 | 説明 |
|---|---|
| Disabled | |
| Enabled |
ReadWriteEndpointFailoverPolicy
フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 failoverPolicy が自動の場合、failoverWithDataLossGracePeriodMinutes が必要です。
| 値 | 説明 |
|---|---|
| Manual | |
| Automatic |
SecondaryInstanceType
geo セカンダリ インスタンスの種類。 インスタンスが DR オプションとしてのみ使用されている場合は、"スタンバイ" を設定します。
| 値 | 説明 |
|---|---|
| Geo | |
| Standby |