Elastic Pools - Get

  • リファレンス
Service:
SQL Database
API Version:
2021-11-01

エラスティック プールを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}?api-version=2021-11-01

URI パラメーター

名前 / 必須 型 説明
elasticPoolName
 path True

string

エラスティック プールの名前。
resourceGroupName
 path True

string

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

string

サーバーの名前。
subscriptionId
 path True

string

Azure サブスクリプションを識別するサブスクリプション ID。
api-version
 query True

string

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

応答

名前 型 説明
200 OK

ElasticPool

成功
Other Status Codes

エラー応答: ***

  • 400 ElasticPoolOverStorageUsage - エラスティック プールのストレージ制限に達したときにデータベースにデータを書き込もうとします。

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

  • 400 InvalidTierSkuCombination - 指定されたレベルは、指定された SKU をサポートしていません。

  • 400 ServerQuotaExceeded - サーバーが許可されるデータベース スループット ユニットの制限に達しました。

  • 400 ElasticPoolAlreadyExists - サーバーには、指定された名前のエラスティック プールが既に含まれています。

  • 400 SubscriptionVcoreQuotaExceeded - サブスクリプションが許可されている仮想コア クォータを超えるので、操作を実行できませんでした。

  • 400 InvalidInputValueForEdition - 指定されたエディションは、エラスティック プールのプロビジョニングではサポートされていません。

  • 400 ElasticPoolDtuBelowLimit - 要求された DTU 値が、要求されたエラスティック プール サービス レベルに対して低すぎます。

  • 400 ElasticPoolDtuAboveLimit - 要求された DTU 値が、要求されたエラスティック プール サービス レベルに対して高すぎます。

  • 400 InvalidMaxSize - 最大サイズが無効です。

  • 400 ElasticPoolDbDtuMaxBelowLimit - データベースあたりの要求された DTU max が、要求されたエラスティック プール サービス レベルに対して低すぎます。

  • 400 ElasticPoolDbDtuMaxAboveLimit - データベースごとに要求された DTU max が、要求されたエラスティック プール サービス レベルに対して高すぎます。

  • 400 InvalidInputValueForDatabaseDtuMax - 許可された値と一致しないリソース プールのデータベースあたりの DTU の最大値を設定しようとしています。

  • 400 ElasticPoolDbDtuMinAboveLimit - 要求されたサービス レベルに対してデータベースあたりの要求された DTU min が高すぎます。

  • 400 ElasticPoolOverStorage - エラスティック プールのストレージ制限に達したときにデータベースにデータを書き込もうとします。

  • 400 InvalidInputValueForDatabaseDtuMin - 許可された値と一致しないリソース プールのデータベースあたりの DTU 最小数を設定しようとしています。

  • 400 ElasticPoolInconsistentDtuGuaranteeSettings - エラスティック プールの要求された DTU を超えるエラスティック プール内のデータベースに DTU min を提供しようとしています。

  • 400 ElasticPoolDtuUnsupported - ユーザーは、サポートされていない DTU 容量でエラスティック プールを作成または更新しようとしました。

  • 400 ElasticPoolStorageAboveLimitGB - エラスティック プールの記憶域の制限をサポートされている制限を下回って設定しようとしています。

  • 400 ElasticPoolsNotEnabled - このリージョンでエラスティック プールが有効になっていません。

  • 400 ElasticPoolNotEmpty - 空ではないエラスティック プールの削除を要求します。

  • 400 ElasticPoolStorageBelowLimitGB - エラスティック プールの記憶域の制限をサポートされている制限を下回って設定しようとしています。

  • 400 ElasticPoolStorageNotAllowedGB - 許可された値と一致しないエラスティック プールの記憶域の制限を gb 単位で設定しようとしています。

  • 400 ElasticPoolDatabaseLimit - エラスティック プールがデータベース数の上限に達しました。

  • 400 ElasticPoolDecreaseStorageLimitBelowUsage - エラスティック プールのストレージ制限を、そのストレージ使用量を下回ろうとしています。

  • 400 InvalidInputValueDatabaseDtuMinLargerThanMax - データベースあたりの DTU 最小数をデータベースあたりの DTU 最大値より高く設定しようとしています。

  • 400 ElasticPoolInconsistentVcoreGuaranteeSettings - データベースの数とデータベースあたりの仮想コアの最小数は、エラスティック プールの要求された仮想コアを超えることはできません。

  • 400 ElasticPoolStorageBelowLimitMB - エラスティック プールの記憶域の制限をサポートされている制限を下回って設定しようとしています。

  • 400 ElasticPoolStorageNotAllowedMB - 許可された値と一致しないエラスティック プールの記憶域制限を mb 単位で設定しようとしています。

  • 400 ElasticPoolCapacityStorageNotAllowedMB - 許可された値と一致しないエラスティック プールストレージの制限を mb 単位で設定しようとしています。

  • 400 ElasticPoolStorageAboveLimitMB - エラスティック プールの記憶域の制限をサポートされている制限を下回って設定しようとしています。

  • 400 RegionDoesNotSupportVersion - ユーザーは、指定したバージョンのサーバーを、そのサーバー バージョンがサポートされていない場所に作成しようとしました。

  • 400 InvalidTier - ユーザーが無効なレベルを指定しました。

  • 400 SourceDatabaseEditionCouldNotBeUpgraded - ソース データベースのエディションをターゲット データベースよりも大きくすることはできません。

  • 400 TargetDatabaseEditionCouldNotBeDowngraded - ターゲット データベースのエディションをソース データベースよりも低くすることはできません。

  • 400 ElasticPoolUpdateHkNotAllowed - エラスティック プールは、1 つ以上のデータベースでメモリ最適化オブジェクトを使用するため、サービス レベルを Premium から Standard または Basic に下げることはできません。

  • 400 UpdateNotAllowedIfGeoDrOperationInProgress - サーバー '{1}' のデータベース '{0}' のコピーまたはフェールオーバー操作が現在進行中のため、操作は許可されていません。

  • 400 RegionDoesNotAllowProvisioning - 選択した場所が新しい Windows Azure SQL データベース サーバーを受け入れません。 これは後で変更される場合があります。

  • 400 ElasticPoolOverFileSpace - エラスティック プール内のファイル領域が不足しています。

  • 400 ElasticPoolDbDtuMinBelowLimit - データベースあたりの要求された DTU min が、要求されたエラスティック プール サービス レベルに対して低すぎます。

  • 400 ElasticPoolDbVcoreMaxBelowLimit - データベースあたりの要求された仮想コアの最大値が、要求されたエラスティック プール サービス レベルに対して低すぎます。

  • 400 ElasticPoolDbVcoreMaxAboveLimit - データベースあたりの要求された仮想コアの最大値が、要求されたエラスティック プール サービス レベルに対して高すぎます。

  • 400 InvalidInputValueForDatabaseVcoreMax - 許可された値と一致しないリソース プールのデータベースあたりの仮想コアの最大数を設定しようとしています。

  • 400 ElasticPoolDbVcoreMinBelowLimit - 要求されたデータベースあたりの仮想コア最小数が、要求されたエラスティック プール サービス レベルに対して低すぎます。

  • 400 InvalidInputValueForDatabaseVcoreMin - 許可された値と一致しないリソース プールのデータベースあたりの仮想コア最小数を設定しようとしています。

  • 400 PartnerDBNotCompatibleForSGXEnclave - エンクレーブ対応データベースの GeoDR リンクの設定または SLO の更新の試行は、両方のデータベースが DC シリーズ ハードウェアで実行されている場合にのみサポートされます。

  • 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - データベースあたりの仮想コア最小数をデータベースあたりの仮想コアの最大値より高く設定しようとしています。

  • 400 InvalidLicenseType - ユーザーが、サポートされていないライセンスの種類でデータベースまたはエラスティック プールを作成または更新しようとしました。

  • 400 ProvisioningDisabled - リソース操作オーソライザーからのエラー メッセージをそのまま表示します(変更なし)

  • 400 InvalidPublicMaintenanceConfiguration - ユーザーがパブリック メンテナンス構成を指定しようとしましたが、内部 ID (形式が正しくない、または間違ったリージョン) に変換できません。

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

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

  • 404 ElasticPoolNotFound - 指定されたサーバーに指定されたエラスティック プールが存在しません。

  • 404 OperationIdNotFound - Id を持つ操作が存在しません。

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

  • 405 NotSupported - この機能はサポートされていません。

  • 409 ElasticPoolBusy - ビジー状態のエラスティック プールで管理操作が試行されました。

  • 409 ServerDisabled - サーバーが無効になっています。

  • 409 SimultaneousSkuChangeNotAllowed - レプリケーション関係の両方のデータベースでサービス目標変更操作を同時に実行することはできません。

  • 409 ElasticPoolUpdateLinksNotInCatchup - データベースの 1 つがコピーまたは geo レプリケーションフェールオーバー操作を実行している間、エラスティック プールを更新できません。

  • 409 OperationCancelled - 操作がユーザーによって取り消されました。

  • 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。

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

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

  • 500 ElasticPoolFailedMoveDbToElasticPool - 内部リソースの制約により、データベースをエラスティック プールに移動できませんでした。 これは一時的な状態である可能性があります。再試行してください。

  • 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作をやり直してください。

  • 503 ServiceTemporarilyUnavailable - 機能を一時的に使用できません。

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

例

Get a Hyperscale elastic pool
Get an elastic pool

Get a Hyperscale elastic pool

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102?api-version=2021-11-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "location": "Japan East",
  "kind": "vcore,pool",
  "sku": {
    "name": "HS_Gen5",
    "tier": "Hyperscale",
    "family": "Gen5",
    "capacity": 4
  },
  "properties": {
    "state": "Ready",
    "creationDate": "2021-08-26T03:46:20.57Z",
    "maxSizeBytes": 0,
    "perDatabaseSettings": {
      "minCapacity": 0,
      "maxCapacity": 4
    },
    "zoneRedundant": false,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default",
    "highAvailabilityReplicaCount": 2
  }
}

Get an elastic pool

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102?api-version=2021-11-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102",
  "name": "sqlcrudtest-8102",
  "type": "Microsoft.Sql/servers/elasticPools",
  "location": "Japan East",
  "kind": null,
  "sku": {
    "name": "GP_Gen5_2",
    "tier": "GeneralPurpose",
    "capacity": 2
  },
  "properties": {
    "creationDate": "2017-10-10T01:25:25.033Z",
    "state": "Ready",
    "maxSizeBytes": 5242880000,
    "perDatabaseSettings": {
      "minCapacity": 0.25,
      "maxCapacity": 1
    },
    "zoneRedundant": true,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1"
  }
}

定義

名前 説明
ElasticPool

エラスティック プール。
ElasticPoolLicenseType

このエラスティック プールに適用するライセンスの種類。
ElasticPoolPerDatabaseSettings

エラスティック プールのデータベース設定ごと。
ElasticPoolState

エラスティック プールの状態。
Sku

ARM リソース SKU。

ElasticPool

エラスティック プール。

名前 型 説明
id

string

リソースの ID
kind

string

エラスティック プールの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。
location

string

リソースの場所。
name

string

リソース名。
properties.creationDate

string

エラスティック プールの作成日 (ISO8601形式)。
properties.highAvailabilityReplicaCount

integer

高可用性を提供するために使用されるエラスティック プールに関連付けられているセカンダリ レプリカの数。 Hyperscale エラスティック プールにのみ適用されます。
properties.licenseType

ElasticPoolLicenseType

このエラスティック プールに適用するライセンスの種類。
properties.maintenanceConfigurationId

string

エラスティック プールに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンス更新が発生する期間を定義します。
properties.maxSizeBytes

integer

データベース エラスティック プールのストレージ制限 (バイト単位)。
properties.minCapacity

number

一時停止されていない場合、サーバーレス プールが以下に縮小しない最小容量
properties.perDatabaseSettings

ElasticPoolPerDatabaseSettings

エラスティック プールのデータベースごとの設定。
properties.state

ElasticPoolState

エラスティック プールの状態。
properties.zoneRedundant

boolean

このエラスティック プールがゾーン冗長かどうか。つまり、このエラスティック プールのレプリカは複数の可用性ゾーンに分散されます。
sku

Sku

エラスティック プール SKU。

SKU の一覧は、リージョンとサポート オファーによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、REST API または次のコマンドを使用 Capabilities_ListByLocation します。

az sql elastic-pool list-editions -l <location> -o table
tags

object

リソース タグ。
type

string

リソースの種類。

ElasticPoolLicenseType

このエラスティック プールに適用するライセンスの種類。

名前 型 説明
BasePrice

string

LicenseIncluded

string

ElasticPoolPerDatabaseSettings

エラスティック プールのデータベース設定ごと。

名前 型 説明
maxCapacity

number

1 つのデータベースで使用できる最大容量。
minCapacity

number

すべてのデータベースの最小容量が保証されます。

ElasticPoolState

エラスティック プールの状態。

名前 型 説明
Creating

string

Disabled

string

Ready

string

Sku

ARM リソース SKU。

名前 型 説明
capacity

integer

特定の SKU の容量。
family

string

サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。
name

string

SKU の名前 (通常は文字 + 番号コード、例: P3)。
size

string

特定の SKU のサイズ
tier

string

特定の SKU のレベルまたはエディション (Basic、Premium など)。