Elastic Pools REST API Reference

This section details the REST API operations available for managing Azure SQL Database Elastic Pools.

Elastic Pool Operations

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools

Retrieves a list of all elastic pools in a given SQL server.

Parameters

Name	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Yes
resourceGroupName	string	The name of the resource group that contains the resource.	Yes
serverName	string	The name of the SQL server.	Yes

Responses

Code	Description	Schema
200 OK	Successfully retrieved the list of elastic pools.	ElasticPoolListResult
404 Not Found	The specified server or resource group was not found.	ErrorResponse

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}

Retrieves the properties of a specific elastic pool.

Parameters

Name	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Yes
resourceGroupName	string	The name of the resource group that contains the resource.	Yes
serverName	string	The name of the SQL server.	Yes
elasticPoolName	string	The name of the elastic pool to retrieve.	Yes

Responses

Code	Description	Schema
200 OK	Successfully retrieved the elastic pool properties.	ElasticPool
404 Not Found	The specified elastic pool, server, or resource group was not found.	ErrorResponse

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}

Creates or updates an elastic pool.

Parameters

Name	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Yes
resourceGroupName	string	The name of the resource group that contains the resource.	Yes
serverName	string	The name of the SQL server.	Yes
elasticPoolName	string	The name of the elastic pool.	Yes
api-version	string	API version.	Yes

Request Body

Contains the properties of the elastic pool to be created or updated.


                                {
                                    "location": "string",
                                    "sku": {
                                        "name": "string",
                                        "tier": "string"
                                    },
                                    "properties": {
                                        "storageMB": "integer",
                                        "minPoolSizeInDTUs": "integer",
                                        "maxPoolSizeInDTUs": "integer",
                                        "zoneRedundant": "boolean"
                                    }
                                }

Responses

Code	Description	Schema
201 Created	Elastic pool created successfully.	ElasticPool
200 OK	Elastic pool updated successfully.	ElasticPool
400 Bad Request	Invalid request payload.	ErrorResponse
404 Not Found	The specified server or resource group was not found.	ErrorResponse

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}

Deletes an elastic pool.

Parameters

Name	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Yes
resourceGroupName	string	The name of the resource group that contains the resource.	Yes
serverName	string	The name of the SQL server.	Yes
elasticPoolName	string	The name of the elastic pool to delete.	Yes

Responses

Code	Description	Schema
204 No Content	Elastic pool deleted successfully.	N/A
404 Not Found	The specified elastic pool, server, or resource group was not found.	ErrorResponse

Elastic Pool Edits

This section covers operations related to editing existing elastic pools, such as changing their SKU or performance characteristics.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}

Updates the properties of an existing elastic pool. This can include scaling resources or changing the SKU.

Parameters

Name	Type	Description	Required
subscriptionId	string	The ID of the target subscription.	Yes
resourceGroupName	string	The name of the resource group that contains the resource.	Yes
serverName	string	The name of the SQL server.	Yes
elasticPoolName	string	The name of the elastic pool to update.	Yes
api-version	string	API version.	Yes

Request Body

Contains the properties to be updated for the elastic pool.


                                {
                                    "sku": {
                                        "name": "string", // e.g., "BasicPool", "StandardPool", "PremiumPool"
                                        "tier": "string"  // e.g., "Basic", "Standard", "Premium"
                                    },
                                    "properties": {
                                        "storageMB": "integer",
                                        "minPoolSizeInDTUs": "integer",
                                        "maxPoolSizeInDTUs": "integer"
                                    }
                                }

Responses

Code	Description	Schema
200 OK	Elastic pool updated successfully.	ElasticPool
400 Bad Request	Invalid request payload or SKU combination.	ErrorResponse
404 Not Found	The specified elastic pool, server, or resource group was not found.	ErrorResponse

Resource Schemas

ElasticPool

Represents an Azure SQL Database Elastic Pool.


{
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}",
    "name": "string",
    "type": "Microsoft.Sql/servers/elasticPools",
    "location": "string",
    "sku": {
        "name": "string",
        "tier": "string",
        "capacity": "integer"
    },
    "properties": {
        "creationDate": "string (date-time)",
        "status": "string",
        "storageMB": "integer",
        "maxSizeBytes": "integer",
        "minPoolSizeInDTUs": "integer",
        "maxPoolSizeInDTUs": "integer",
        "zoneRedundant": "boolean"
    }
}

ElasticPoolListResult

Represents a list of Azure SQL Database Elastic Pools.


{
    "value": [
        {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}",
            "name": "string",
            "type": "Microsoft.Sql/servers/elasticPools",
            "location": "string",
            "sku": {
                "name": "string",
                "tier": "string",
                "capacity": "integer"
            },
            "properties": {
                "creationDate": "string (date-time)",
                "status": "string",
                "storageMB": "integer",
                "maxSizeBytes": "integer",
                "minPoolSizeInDTUs": "integer",
                "maxPoolSizeInDTUs": "integer",
                "zoneRedundant": "boolean"
            }
        }
    ],
    "nextLink": "string"
}

ErrorResponse

Standard error response object.


{
    "error": {
        "code": "string",
        "message": "string",
        "details": [
            {
                "code": "string",
                "message": "string"
            }
        ]
    }
}