Instance Failover Groups - Get

サービス:: SQL Database

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

フェールオーバーグループを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2025-01-01

URI パラメーター

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

応答

名前	型	説明
200 OK	InstanceFailoverGroup	Azureの運用は無事に完了しました。
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	ユーザーアカウントを偽装する

例

Get failover group

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test?api-version=2025-01-01

応答のサンプル

状態コード:: 200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
InstanceFailoverGroup	インスタンスフェールオーバーグループ。
InstanceFailoverGroupReadOnlyEndpoint	フェールオーバーグループインスタンスの読み取り専用エンドポイント。
InstanceFailoverGroupReadWriteEndpoint	フェールオーバーグループインスタンスの読み取り/書き込みエンドポイント。
InstanceFailoverGroupReplicationRole	フェールオーバーグループインスタンスのローカルレプリケーションロール。
ManagedInstancePairInfo	フェールオーバーグループ内のマネージドインスタンスのペア。
PartnerRegionInfo	フェールオーバーグループのパートナーリージョン情報。
ReadOnlyEndpointFailoverPolicy	フェールオーバーグループの読み取り専用エンドポイントのフェールオーバーポリシー。
ReadWriteEndpointFailoverPolicy	フェールオーバーグループの読み取り/書き込みエンドポイントのフェールオーバーポリシー。 failoverPolicy が自動の場合、failoverWithDataLossGracePeriodMinutes が必要です。
SecondaryInstanceType	geo セカンダリインスタンスの種類。インスタンスが DR オプションとしてのみ使用されている場合は、"スタンバイ" を設定します。
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	エラーオブジェクト。

InstanceFailoverGroup

Object

インスタンスフェールオーバーグループ。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.managedInstancePairs	ManagedInstancePairInfo[]	フェールオーバーグループ内のマネージドインスタンスペアの一覧。
properties.partnerRegions	PartnerRegionInfo[]	フェールオーバーグループのパートナーリージョン情報。
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	フェールオーバーグループインスタンスの読み取り専用エンドポイント。
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	フェールオーバーグループインスタンスの読み取り/書き込みエンドポイント。
properties.replicationRole	InstanceFailoverGroupReplicationRole	フェールオーバーグループインスタンスのローカルレプリケーションロール。
properties.replicationState	string	フェールオーバーグループインスタンスのレプリケーション状態。
properties.secondaryType	SecondaryInstanceType	geo セカンダリインスタンスの種類。インスタンスが DR オプションとしてのみ使用されている場合は、"スタンバイ" を設定します。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

InstanceFailoverGroupReadOnlyEndpoint

Object

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

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

InstanceFailoverGroupReadWriteEndpoint

Object

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

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

InstanceFailoverGroupReplicationRole

列挙

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

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

ManagedInstancePairInfo

Object

フェールオーバーグループ内のマネージドインスタンスのペア。

名前	型	説明
partnerManagedInstanceId	string	Partner Managed Instance in pairのid。
primaryManagedInstanceId	string	Primary Managed Instance in pair のid。

PartnerRegionInfo

Object

フェールオーバーグループのパートナーリージョン情報。

名前	型	説明
location	string	パートナーマネージドインスタンスの地理的な場所。
replicationRole	InstanceFailoverGroupReplicationRole	パートナーマネージドインスタンスのレプリケーションロール。

ReadOnlyEndpointFailoverPolicy

列挙

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

値	説明
Disabled	Disabled
Enabled	有効

ReadWriteEndpointFailoverPolicy

列挙

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

値	説明
Manual	手動
Automatic	自動

SecondaryInstanceType

列挙

geo セカンダリインスタンスの種類。インスタンスが DR オプションとしてのみ使用されている場合は、"スタンバイ" を設定します。

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

systemData

Object

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

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

次の方法で共有

Instance Failover Groups - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

Get failover group

要求のサンプル

応答のサンプル

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData