Elastic Pools - Get
Gets an elastic pool.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}?api-version=2023-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
elastic
|
path | True |
string |
The name of the elastic pool. |
resource
|
path | True |
string |
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
server
|
path | True |
string |
The name of the server. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
api-version
|
query | True |
string |
The API version to use for the request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Succeeded |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
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
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=2023-08-01
Sample response
{
"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=2023-08-01
Sample response
{
"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
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=2023-08-01
Sample response
{
"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
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=2023-08-01
Sample response
{
"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
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=2023-08-01
Sample response
{
"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"
}
}
Definitions
Name | Description |
---|---|
Always |
Type of enclave requested on the elastic pool. |
Availability |
Specifies the availability zone the pool's primary replica is pinned to. |
Elastic |
An elastic pool. |
Elastic |
The license type to apply for this elastic pool. |
Elastic |
Per database settings of an elastic pool. |
Elastic |
The state of the elastic pool. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Sku |
An ARM Resource SKU. |
AlwaysEncryptedEnclaveType
Type of enclave requested on the elastic pool.
Value | Description |
---|---|
Default | |
VBS |
AvailabilityZoneType
Specifies the availability zone the pool's primary replica is pinned to.
Value | Description |
---|---|
1 | |
2 | |
3 | |
NoPreference |
ElasticPool
An elastic pool.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
kind |
string |
Kind of elastic pool. This is metadata used for the Azure portal experience. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.autoPauseDelay |
integer (int32) |
Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled |
properties.availabilityZone |
Specifies the availability zone the pool's primary replica is pinned to. |
|
properties.creationDate |
string (date-time) |
The creation date of the elastic pool (ISO8601 format). |
properties.highAvailabilityReplicaCount |
integer (int32) |
The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. |
properties.licenseType |
The license type to apply for this elastic pool. |
|
properties.maintenanceConfigurationId |
string |
Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. |
properties.maxSizeBytes |
integer (int64) |
The storage limit for the database elastic pool in bytes. |
properties.minCapacity |
number (double) |
Minimal capacity that serverless pool will not shrink below, if not paused |
properties.perDatabaseSettings |
The per database settings for the elastic pool. |
|
properties.preferredEnclaveType |
Type of enclave requested on the elastic pool. |
|
properties.state |
The state of the elastic pool. |
|
properties.zoneRedundant |
boolean |
Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. |
sku |
The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the
|
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
ElasticPoolLicenseType
The license type to apply for this elastic pool.
Value | Description |
---|---|
BasePrice | |
LicenseIncluded |
ElasticPoolPerDatabaseSettings
Per database settings of an elastic pool.
Name | Type | Description |
---|---|---|
autoPauseDelay |
integer (int32) |
Auto Pause Delay for per database within pool |
maxCapacity |
number (double) |
The maximum capacity any one database can consume. |
minCapacity |
number (double) |
The minimum capacity all databases are guaranteed. |
ElasticPoolState
The state of the elastic pool.
Value | Description |
---|---|
Creating | |
Disabled | |
Ready |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
Sku
An ARM Resource SKU.
Name | Type | Description |
---|---|---|
capacity |
integer (int32) |
Capacity of the particular SKU. |
family |
string |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
name |
string |
The name of the SKU, typically, a letter + Number code, e.g. P3. |
size |
string |
Size of the particular SKU |
tier |
string |
The tier or edition of the particular SKU, e.g. Basic, Premium. |