次の方法で共有


Instance Failover Groups - Get

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

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

URI パラメーター

名前 / 必須 説明
failoverGroupName
path True

string

フェールオーバー グループの名前。

locationName
path True

string

リソースが配置されているリージョンの名前。

resourceGroupName
path True

string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

subscriptionId
path True

string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True

string

要求で使用する API のバージョン。

応答

名前 説明
200 OK

InstanceFailoverGroup

指定したフェールオーバー グループが正常に取得されました。

Other Status Codes

エラー応答: ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - インスタンスの作成または更新のフェールオーバー グループ要求本文の指定されたプライマリ フィールドが空または無効です。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - インスタンスの作成または更新のフェールオーバー グループ要求本文の指定されたパートナー フィールドが空または無効です。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - 指定された 1 つ以上のパートナー サーバーが既にインスタンス フェールオーバー グループの一部です。 プライマリ サーバーと指定されたすべてのパートナー サーバーが一意であることを確認してください。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - インスタンス フェールオーバー グループ要求本文で指定されたパートナー マネージド インスタンス リージョンが空または無効です。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - サポートされているパートナー リージョンは 1 つだけです。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - 1 つのマネージド インスタンス ペアのみがサポートされます。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - 要求の作成または更新には readWriteEndpoint フィールドが必要です。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - インスタンスの作成または更新のフェールオーバー グループ要求本文が空または無効です。

  • 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - セカンダリ サーバーでは、インスタンス フェールオーバー グループの変更は許可されません。 プライマリ サーバーで要求を実行します。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - 読み取り/書き込みエンドポイントの猶予期間値は負でない必要があります。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - インスタンス フェールオーバー グループの猶予期間値は、最小猶予期間 '{0}' 分以上である必要があります

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - 読み取り/書き込みエンドポイントでフェールオーバー ポリシー自動が選択されている場合は、プロパティ failoverWithDataLossGracePeriodMinutes を指定する必要があります。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - 作成要求または更新要求には、読み取り/書き込みエンドポイントの failoverPolicy フィールドが必要です。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - 読み取り/書き込みエンドポイントにフェールオーバー ポリシー Manual が選択されている場合は、猶予期間値を指定しないでください。

  • 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - インスタンスの作成または更新のフェールオーバー グループ要求本文で読み取り専用プロパティ '{0}' を変更しないでください。

  • 400 InstanceFailoverGroupFailoverRequestOnPrimary - インスタンス フェールオーバー グループのセカンダリ サーバーでフェールオーバー要求を開始する必要があります。

  • 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - フェールオーバー グループのプライマリ サーバーとパートナー サーバーは、異なるサブスクリプションから取得されます。 フェールオーバー グループのサーバーのクロス サブスクリプションは許可されません。

  • 400 FailoverGroupRegionMismatch - フェールオーバー グループで指定されたパートナー リージョンは、指定されたパートナー マネージド インスタンスのリージョンと一致する必要があります。

  • 400 ServerEditionMismatch - レプリカ サーバーの作成時に、エディションはプライマリ サーバーと同じである必要があります。

  • 400 DnsZoneMismatch - パートナー サーバーの DNSZone は、ソース サーバーの DNSZone とは異なります。 これにより、InstanceFailoverGroup 機能が中断されます。

  • 400 InvalidTargetSubregion - 読み取り不可能なセカンダリのターゲット サーバーが DR ペアの Azure リージョンにありません。

  • 400 GeoDrInstanceSizeMismatch - プライマリ マネージド インスタンスとパートナー マネージド インスタンスのストレージ サイズが同じではありません。

  • 400 SecurityAdalPrincipalCertExpiredError - Azure Key Vault プリンシパル証明書の有効期限が切れているため、操作を完了できませんでした。

  • 400 GeoDrSecondaryInstanceNotEmpty - セカンダリ マネージド インスタンスにはユーザー データベースがあります。 インスタンス フェールオーバー グループを作成するには、セカンダリ マネージド インスタンスが空である必要があります。

  • 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - ネットワーク構成が正しくありません。 プライマリ サーバーのレプリケーション トラフィックがセカンダリ サーバーに到達できません。

  • 400 IncorrectReplicationLinkState - この操作では、データベースがレプリケーション リンクで予期された状態であることが想定されます。

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 指定されたKey Vault URI が無効です。

  • 400 KeyMaterialNotFoundOnRemoteServer - リモート サーバーは、TDE 保護機能として使用されるキー マテリアルにアクセスできません。

  • 400 AzureKeyVaultRsaKeyNotSupported - 提供されたキー コンテナーでは、サポートされていない RSA キー サイズまたはキーの種類が使用されます。 サポートされている RSA キー サイズは 2048 または 3072 で、キーの種類は RSA または RSA-HSM です。

  • 400 UnableToResolveRemoteServer - サーバー名または DNS 接続の問題が無効なため、リモート パートナー サーバー名を解決できませんでした。

  • 400 SameKeyUriNotFoundOnRemoteServer - セカンダリ サーバーには、キーの自動ローテーションが有効になっているプライマリ サーバーの暗号化保護機能と同じキー コンテナーのキー マテリアルがありません。

  • 400 RemoteDatabaseCopyPermission - 指定されたサーバーにデータベース コピーを作成するための十分な権限がありません。

  • 400 SameKeyMaterialNotFoundOnRemoteServer - セカンダリ サーバーには、プライマリ サーバーの暗号化保護機能のキー マテリアルがありません。

  • 400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。

  • 400 InvalidFailoverGroupRegion - インスタンス フェールオーバー グループで指定されたサーバーは、分離を提供するために異なるリージョンに存在する必要があります。

  • 400 InstanceFailoverGroupDoesNotExist - フェールオーバー グループがサーバー上に存在しません。

  • 400 InstanceFailoverGroupNotSecondary - インスタンス フェールオーバー グループ内のプライマリ サーバーからフェールオーバーを開始できません。

  • 400 InvalidServerName - 無効なサーバー名が指定されています。

  • 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。

  • 400 TokenTooLong - 指定されたトークンが長すぎます。

  • 400 AzureKeyVaultKeyDisabled - Azure Key Vault キーが無効になっているため、サーバーで操作を完了できませんでした。

  • 400 AzureKeyVaultInvalidExpirationDate - Azure Key Vault キーの有効期限が無効であるため、操作を完了できませんでした。

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - Azure Key Vault Uri が null または空であるため、操作を完了できませんでした。

  • 400 InvalidSku - ユーザーが無効な SKU を指定しました。

  • 400 InvalidAddSecondaryPermission - 指定されたサーバーにセカンダリを追加するための十分なアクセス許可がありません。

  • 400 ServerNotFound - 要求されたサーバーが見つかりませんでした。

  • 400 AzureKeyVaultNoServerIdentity - サーバー ID が正しく構成されていません。

  • 400 AzureKeyVaultInvalidUri - Azure Key Vault からの無効な応答。 有効な Azure Key Vault URI を使用してください。

  • 400 AzureKeyVaultMissingPermissions - サーバーに Azure Key Vaultに必要なアクセス許可がありません。

  • 400 SecurityAzureKeyVaultInvalidKeyName - サーバー キー名が無効なため、操作を完了できませんでした。

  • 400 PlannedFailoverTimedOutForDatabase - ユーザーが計画フェールオーバー呼び出し、タイムアウトし、特定のデータベースが原因と思われます。

  • 400 PlannedFailoverTimedOut - ユーザーが計画フェールオーバー呼び出し、パートナー管理サービスに問い合わせようとしているときにタイムアウトしました。

  • 400 AdalGenericError - Azure Active Directory エラーが発生したため、操作を完了できませんでした。

  • 400 GeoReplicationDatabaseNotSecondary - この操作では、データベースがレプリケーション ターゲットであることが想定されます。

  • 400 AdalServicePrincipalNotFound - Azure Active Directory ライブラリのサービス プリンシパルが見つからないというエラーが発生したため、操作を完了できませんでした。

  • 400 AzureKeyVaultMalformedVaultUri - 指定されたKey Vault URI が無効です。

  • 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベース エディションで無効になっている機能を使用しようとしました。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • 404 SourceDatabaseNotFound - ソース データベースが存在しません。

  • 404 ServerNotInSubscription - 指定されたサブスクリプションに指定されたサーバーが存在しません。

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。

  • 405 UnsupportedReplicationOperation - サポートされていないレプリケーション操作がデータベースで開始されました。

  • 409 ManagedInstanceHasHybridLink - ユーザーが、マネージド インスタンスにハイブリッド リンクが構成されている場合にサポートされていない操作を開始しようとしました。

  • 409 RemoteDatabaseExists - 宛先データベース名は、宛先サーバーに既に存在します。

  • 409 ConflictingServerOperation - サーバーの操作は現在進行中です。

  • 409 SubscriptionDisabled - サブスクリプションが無効になっています。

  • 409 InstanceFailoverGroupAlreadyExists - フェールオーバー グループは、特定のサーバーに既に存在します。

  • 409 InstanceFailoverGroupBusy - インスタンス フェールオーバー グループが別の操作でビジー状態です。

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo - セカンダリが物理的に一貫性がないため、プライマリ ロールを入力できない状態にあるときに、geo リンクをフェールオーバーまたは強制終了しようとしました。

  • 409 InstanceFailoverGroupDnsRecordInUse - 要求されたエンドポイントに重複する DNS レコードが存在します。

  • 409 ServerKeyNameAlreadyExists - サーバー 上にサーバー キーが既に存在します。

  • 409 ServerKeyUriAlreadyExists - サーバー 上にサーバー キー URI が既に存在します。

  • "409 ServerKeyDoesNotExists - The server key does not exist. " (409 ServerKeyDoesNotExists - サーバー キーは存在しません。)

  • 409 InvalidFailoverGroupName - 無効なインスタンス フェールオーバー グループ名が指定されました。

  • 409 UpdateSloInProgress - SLO 更新の進行中に、ユーザーが互換性のない操作を開始しようとしました。

  • 409 AzureKeyVaultKeyNameNotFound - Azure Key Vault キー名が存在しないため、操作を完了できませんでした。

  • 409 AzureKeyVaultKeyInUse - キーは現在サーバーによって使用されています。

  • 409 ConflictingSystemOperationInProgress - データベースでシステムメンテナンス操作が進行中であり、完了するまでそれ以上の操作を待機する必要があります。

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - レプリケーション のシード処理操作が、既にレプリケーション 関係にあるデータベースで実行されました。

  • 409 InvalidDatabaseStateForOperation - この操作は、現在のレプリケーション状態のデータベースでは許可されていません。

  • 409 DuplicateGeoDrRelation - データベースは既にレプリケーション関係にあります。 これは重複する要求です。

  • 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

  • 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

  • 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

  • 503 AzureKeyVaultConnectionFailed - Azure Key Vaultへの接続試行が失敗したため、サーバーで操作を完了できませんでした

  • 503 AzureKeyVaultGenericConnectionError - Key Vault情報を取得しようとしたときにエラーが発生したため、操作を完了できませんでした。

  • 504 RequestTimeout - サービス要求が許可されたタイムアウトを超えました。

Get failover group

要求のサンプル

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=2021-11-01

応答のサンプル

{
  "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"
      }
    ]
  }
}

定義

名前 説明
InstanceFailoverGroup

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

InstanceFailoverGroupReadOnlyEndpoint

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

InstanceFailoverGroupReadWriteEndpoint

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

InstanceFailoverGroupReplicationRole

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

ManagedInstancePairInfo

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

PartnerRegionInfo

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

ReadOnlyEndpointFailoverPolicy

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

ReadWriteEndpointFailoverPolicy

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

InstanceFailoverGroup

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

名前 説明
id

string

リソースの ID

name

string

リソース名。

properties.managedInstancePairs

ManagedInstancePairInfo[]

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

properties.partnerRegions

PartnerRegionInfo[]

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

properties.readOnlyEndpoint

InstanceFailoverGroupReadOnlyEndpoint

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

properties.readWriteEndpoint

InstanceFailoverGroupReadWriteEndpoint

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

properties.replicationRole

InstanceFailoverGroupReplicationRole

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

properties.replicationState

string

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

type

string

リソースの種類。

InstanceFailoverGroupReadOnlyEndpoint

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

名前 説明
failoverPolicy

ReadOnlyEndpointFailoverPolicy

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

InstanceFailoverGroupReadWriteEndpoint

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

名前 説明
failoverPolicy

ReadWriteEndpointFailoverPolicy

フェールオーバー グループの読み取り/書き込みエンドポイントのフェールオーバー ポリシー。 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

InstanceFailoverGroupReplicationRole

パートナー マネージド インスタンスのレプリケーション ロール。

ReadOnlyEndpointFailoverPolicy

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

名前 説明
Disabled

string

Enabled

string

ReadWriteEndpointFailoverPolicy

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

名前 説明
Automatic

string

Manual

string