Elastic Pools - Get

サービス:

SQL Database

API バージョン:

2023-08-01

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

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

URI パラメーター

名前	/	必須	型	説明
elasticPoolName	path	True	string	エラスティック プールの名前。
resourceGroupName	path	True	string	リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	ElasticPool	成功
Other Status Codes	ErrorResponse	エラー応答: *** 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合 400 ElasticPoolOverStorageUsage - エラスティック プールのストレージ制限に達したときにデータベースにデータを書き込もうとします。 400 ElasticPoolScaleNotSupportedWithInaccessibleDatabases - エラスティック プールには、TDE 構成に必要な Azure Key Vault アクセスを失ったアクセスできないデータベースが含まれています。 アクセス可能なデータベースを別のプールに移動してスケーリングするか、アクセスできないデータベースの失われた Azure Key Vault アクセスを復元してください。 400 CreateElasticPoolAttemptedWhenKeyRotationInProgress - サーバーでの Transparent Data Encryption (TDE) キーのローテーションが進行中のため、現時点ではエラスティック プールの作成操作を実行できません。 後でもう一度操作を試してください。 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 の最大値が、要求されたエラスティック プール サービス レベルに対して低すぎます。 400 ElasticPoolDbDtuMaxAboveLimit - データベースあたりの要求された DTU の最大値が、要求されたエラスティック プール サービス レベルに対して高すぎます。 400 InvalidInputValueForDatabaseDtuMax - 許可された値と一致しないリソース プールのデータベースあたりの DTU の最大値を設定しようとしています。 400 ElasticPoolDbDtuMinAboveLimit - データベースあたりの要求された DTU 最小数が、要求されたサービス レベルに対して高すぎます。 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 InvalidReadScaleUnits - ユーザーがサポートされていない読み取りスケール値を指定しようとしました。 400 ElasticPoolStorageAboveLimitMB - エラスティック プールの記憶域の制限をサポートされている制限を下回って設定しようとしています。 400 RegionDoesNotSupportVersion - ユーザーが、そのサーバー バージョンがサポートされていない場所に、指定したバージョンのサーバーを作成しようとしました。 400 InvalidTier - ユーザーが無効なレベルを指定しました。 400 SourceDatabaseEditionCouldNotBeUpgraded - ソース データベースは、ターゲット データベースよりも高いエディションを持つことはできません。 400 TargetDatabaseEditionCouldNotBeDowngraded - ターゲット データベースのエディションをソース データベースよりも低くすることはできません。 400 ElasticPoolUpdateHkNotAllowed - エラスティック プールは、1 つ以上のデータベースでメモリ最適化オブジェクトを使用するため、サービス レベルを Premium から Standard または Basic に下げることはできません。 400 UpdateNotAllowedIfGeoDrOperationInProgress - サーバー '{0}' 上のデータベース '{1}' のコピー操作またはフェールオーバー操作が現在進行中であるため、操作は許可されていません。 400 RegionDoesNotAllowProvisioning - 選択した場所が新しい Windows Azure SQL Database サーバーを受け入れません。 これは後で変更される可能性があります。 400 HSElasticPoolUpdateSloPRMSNotSupported - データベースのサービス目標の割り当てが失敗しました。 Microsoft カスタマー サポートに連絡し、サーバー名、データベース名、アクティビティ ID を指定してください。 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 CapacityGroupThresholdExceeded - 要求されたサービス レベルの目標とストレージ サイズは特定の容量グループにマップされ、現在、この容量グループのリソースはしきい値に達しており、それらのリングにデータベースを追加する前に、さらにアクションを実行する必要があります。 400 CapacityGroupThresholdCheckFail - 容量グループのリソース制約チェックに失敗し、操作を完了するのに十分な容量が存在するかどうかを確認できませんでした。 400 InvalidPublicMaintenanceConfiguration - ユーザーが、内部 ID に変換できないパブリック メンテナンス構成 (形式が正しくない、または間違ったリージョン) を指定しようとしました。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ElasticPoolNotFound - 指定されたサーバーに指定されたエラスティック プールが存在しません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 405 NotSupported - この機能はサポートされていません。 409 ElasticPoolBusy - ビジー状態のエラスティック プールで管理操作が試行されました。 409 ServerDisabled - サーバーが無効になっています。 409 SimultaneousSkuChangeNotAllowed - レプリケーション関係の両方のデータベースでサービス目標変更操作を同時に実行することはできません。 409 ElasticPoolUpdateLinksNotInCatchup - データベースの 1 つがコピーまたは geo レプリケーションフェールオーバー操作を実行している間は、エラスティック プールを更新できません。 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。 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 an elastic pool with Availability Zone

Get an elastic pool with preferred enclave type parameter

Get an elastic pool with serverless properties

Get a Hyperscale elastic pool

要求のサンプル

HTTP

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=2023-08-01

応答のサンプル

状態コード:

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

要求のサンプル

HTTP

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=2023-08-01

応答のサンプル

状態コード:

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

Get an elastic pool with Availability Zone

要求のサンプル

HTTP

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=2023-08-01

応答のサンプル

状態コード:

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",
    "availabilityZone": "1"
  }
}

Get an elastic pool with preferred enclave type parameter

要求のサンプル

HTTP

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=2023-08-01

応答のサンプル

状態コード:

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": "GP_Gen5",
    "tier": "GeneralPurpose",
    "family": "Gen5",
    "capacity": 4
  },
  "properties": {
    "state": "Ready",
    "creationDate": "2022-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,
    "preferredEnclaveType": "VBS"
  }
}

Get an elastic pool with serverless properties

要求のサンプル

HTTP

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=2023-08-01

応答のサンプル

状態コード:

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_S_Gen5_2",
    "tier": "GeneralPurpose",
    "capacity": 2
  },
  "properties": {
    "creationDate": "2017-10-10T01:25:25.033Z",
    "state": "Ready",
    "maxSizeBytes": 5242880000,
    "minCapacity": 0.5,
    "autoPauseDelay": 60,
    "perDatabaseSettings": {
      "minCapacity": 0,
      "maxCapacity": 1,
      "autoPauseDelay": 60
    },
    "zoneRedundant": true,
    "licenseType": "LicenseIncluded",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_1"
  }
}

定義

名前	説明
AlwaysEncryptedEnclaveType	エラスティック プールで要求されたエンクレーブの種類。
AvailabilityZoneType	プールのプライマリ レプリカがピン留めされている可用性ゾーンを指定します。
ElasticPool	エラスティック プール。
ElasticPoolLicenseType	このエラスティック プールに適用するライセンスの種類。
ElasticPoolPerDatabaseSettings	エラスティック プールのデータベースごとの設定。
ElasticPoolState	エラスティック プールの状態。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Sku	ARM リソース SKU。

AlwaysEncryptedEnclaveType

列挙

エラスティック プールで要求されたエンクレーブの種類。

値	説明
Default
VBS

AvailabilityZoneType

列挙

プールのプライマリ レプリカがピン留めされている可用性ゾーンを指定します。

値	説明
1
2
3
NoPreference

ElasticPool

Object

エラスティック プール。

名前	型	説明
id	string	リソース ID。
kind	string	エラスティック プールの種類。 これは、Azure portal エクスペリエンスに使用されるメタデータです。
location	string	リソースの場所。
name	string	リソース名。
properties.autoPauseDelay	integer (int32)	エラスティック プールが自動的に一時停止されるまでの時間 (分)。 -1 の値は、自動一時停止が無効になっていることを意味します
properties.availabilityZone	AvailabilityZoneType	プールのプライマリ レプリカがピン留めされている可用性ゾーンを指定します。
properties.creationDate	string (date-time)	エラスティック プールの作成日 (ISO8601形式)。
properties.highAvailabilityReplicaCount	integer (int32)	高可用性を提供するために使用される Business Critical、Premium、または Hyperscale エディションのエラスティック プールに関連付けられているセカンダリ レプリカの数。 Hyperscale エラスティック プールにのみ適用されます。
properties.licenseType	ElasticPoolLicenseType	このエラスティック プールに適用するライセンスの種類。
properties.maintenanceConfigurationId	string	エラスティック プールに割り当てられたメンテナンス構成 ID。 この構成では、メンテナンスの更新が行われる期間を定義します。
properties.maxSizeBytes	integer (int64)	データベース エラスティック プールのストレージ制限 (バイト単位)。
properties.minCapacity	number (double)	一時停止されていない場合、サーバーレス プールが以下に縮小しない最小容量
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	エラスティック プールのデータベースごとの設定。
properties.preferredEnclaveType	AlwaysEncryptedEnclaveType	エラスティック プールで要求されたエンクレーブの種類。
properties.state	ElasticPoolState	エラスティック プールの状態。
properties.zoneRedundant	boolean	このエラスティック プールがゾーン冗長であるかどうか。つまり、このエラスティック プールのレプリカは複数の可用性ゾーンに分散されます。
sku	Sku	エラスティック プール SKU。 SKU の一覧は、リージョンとサポート プランによって異なる場合があります。 Azure リージョンのサブスクリプションで使用できる SKU (SKU 名、レベル/エディション、ファミリ、容量を含む) を確認するには、Capabilities_ListByLocation REST API または次のコマンドを使用します。 az sql elastic-pool list-editions -l <location> -o table
tags	object	リソース タグ。
type	string	リソースの種類。

ElasticPoolLicenseType

列挙

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

値	説明
BasePrice
LicenseIncluded

ElasticPoolPerDatabaseSettings

Object

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

名前	型	説明
autoPauseDelay	integer (int32)	プール内のデータベースごとの自動一時停止遅延
maxCapacity	number (double)	1 つのデータベースで使用できる最大容量。
minCapacity	number (double)	すべてのデータベースの最小容量が保証されます。

ElasticPoolState

列挙

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

値	説明
Creating
Disabled
Ready

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

Sku

Object

ARM リソース SKU。

名前	型	説明
capacity	integer (int32)	特定の SKU の容量。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前 。通常は、文字 + 番号コード (P3 など)。
size	string	特定の SKU のサイズ
tier	string	特定の SKU のレベルまたはエディション (Basic、Premium など)。