Elastic Pools - Get

サービス:
SQL Database
API バージョン:
2025-01-01

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

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

URI パラメーター

名前 / 必須 型 説明
elasticPoolName
 path True

string

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

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前の大文字と小文字は区別されません。
serverName
 path True

string

サーバーの名前。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 型 説明
200 OK

ElasticPool

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

要求のサンプル

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=2025-01-01

応答のサンプル

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

Get an elastic pool

要求のサンプル

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=2025-01-01

応答のサンプル

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

Get an elastic pool with Availability Zone

要求のサンプル

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=2025-01-01

応答のサンプル

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

Get an elastic pool with preferred enclave type parameter

要求のサンプル

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=2025-01-01

応答のサンプル

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

Get an elastic pool with serverless properties

要求のサンプル

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=2025-01-01

応答のサンプル

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

定義

名前 説明
AlwaysEncryptedEnclaveType

データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。
AvailabilityZoneType

データベースがピン留めされる可用性ゾーンを指定します。
createdByType

リソースを作成した ID の種類。
ElasticPool

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

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

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

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

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

エラーの詳細。
ErrorResponse

エラー応答
Sku

ARM リソース SKU。
systemData

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

AlwaysEncryptedEnclaveType

列挙

データベースで要求されたエンクレーブの種類 (既定または VBS エンクレーブ)。

値 説明
Default

デフォルト
VBS

VBS

AvailabilityZoneType

列挙

データベースがピン留めされる可用性ゾーンを指定します。

値 説明
NoPreference

ノープリファレンス
1

1
2

2
3

3

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

ElasticPool

Object

エラスティック プール。

名前 型 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

エラスティック プールの種類。 これはAzureポータル体験で使用されるメタデータです。
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
systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
tags

object

リソース タグ。
type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

ElasticPoolLicenseType

列挙

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

値 説明
LicenseIncluded

ライセンス含録
BasePrice

BasePrice

ElasticPoolPerDatabaseSettings

Object

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

名前 型 説明
autoPauseDelay

integer (int32)

プール内のデータベースごとの自動一時停止遅延
maxCapacity

number (double)

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

number (double)

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

ElasticPoolState

列挙

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

値 説明
Creating

作成
Ready

準備完了
Disabled

Disabled

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 など)。

systemData

Object

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

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。