Elastic Pools - Get

Service:

SQL Database

API Version:

2021-11-01

Gets an elastic pool.

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

URI Parameters

Name	In	Required	Type	Description
elasticPoolName	path	True	string	The name of the elastic pool.
resourceGroupName	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.
serverName	path	True	string	The name of the server.
subscriptionId	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	ElasticPool	Succeeded
Other Status Codes		*** Error Responses: *** 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached. 400 InvalidSku - The user specified an invalid sku. 400 InvalidTierSkuCombination - The specified tier does not support the specified sku. 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit. 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name. 400 SubscriptionVcoreQuotaExceeded - Could not perform the operation because subscription would exceed the allowed vCore quota. 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning. 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier. 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier. 400 InvalidMaxSize - Invalid max size. 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier. 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier. 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values. 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier. 400 ElasticPoolOverStorage - Attempting to write data to a database when the storage limit of the elastic pool has been reached. 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values. 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool. 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported. 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit. 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region. 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty. 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit. 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values. 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases. 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage. 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database. 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool. 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit. 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values. 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values. 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit. 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported. 400 InvalidTier - The user specified an invalid tier. 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database. 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database. 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects. 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress. 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time. 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool. 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier. 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier. 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier. 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values. 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier. 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values. 400 PartnerDBNotCompatibleForSGXEnclave - Attempt to set GeoDR link or update SLO for enclave enabled database is only supported when both database are running on DC-series hardware. 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database. 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type. 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes 400 InvalidPublicMaintenanceConfiguration - User tried to specify public maintenance configuration which cannot be converted to internal id (malformed or wrong region). 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server. 404 OperationIdNotFound - The operation with Id does not exist. 404 ResourceNotFound - The requested resource was not found. 405 NotSupported - This functionality is not supported. 409 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy. 409 ServerDisabled - Server is disabled. 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time. 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 ElasticPoolFailedMoveDbToElasticPool - Failed to move the database into elastic pool due to internal resource constraints. This may be a transient condition, please retry. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Get a Hyperscale elastic pool

Get an elastic pool

Get a Hyperscale elastic pool

Sample request

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

Java

/**
 * Samples for ElasticPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/HyperscaleElasticPoolGet.json
     */
    /**
     * Sample code: Get a Hyperscale elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAHyperscaleElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().getWithResponse("sqlcrudtest-2369",
            "sqlcrudtest-8069", "sqlcrudtest-8102", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

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

Java

/**
 * Samples for ElasticPools Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ElasticPoolGet.json
     */
    /**
     * Sample code: Get an elastic pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnElasticPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getElasticPools().getWithResponse("sqlcrudtest-2369",
            "sqlcrudtest-8069", "sqlcrudtest-8102", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Definitions

Name	Description
ElasticPool	An elastic pool.
ElasticPoolLicenseType	The license type to apply for this elastic pool.
ElasticPoolPerDatabaseSettings	Per database settings of an elastic pool.
ElasticPoolState	The state of the elastic pool.
Sku	An ARM Resource SKU.

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.creationDate	string	The creation date of the elastic pool (ISO8601 format).
properties.highAvailabilityReplicaCount	integer	The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
properties.licenseType	ElasticPoolLicenseType	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	The storage limit for the database elastic pool in bytes.
properties.minCapacity	number	Minimal capacity that serverless pool will not shrink below, if not paused
properties.perDatabaseSettings	ElasticPoolPerDatabaseSettings	The per database settings for the elastic pool.
properties.state	ElasticPoolState	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	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 Capabilities_ListByLocation REST API or the following command: az sql elastic-pool list-editions -l <location> -o table
tags	object	Resource tags.
type	string	Resource type.

ElasticPoolLicenseType

The license type to apply for this elastic pool.

Name	Type	Description
BasePrice	string
LicenseIncluded	string

ElasticPoolPerDatabaseSettings

Per database settings of an elastic pool.

Name	Type	Description
maxCapacity	number	The maximum capacity any one database can consume.
minCapacity	number	The minimum capacity all databases are guaranteed.

ElasticPoolState

The state of the elastic pool.

Name	Type	Description
Creating	string
Disabled	string
Ready	string

Sku

An ARM Resource SKU.

Name	Type	Description
capacity	integer	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.