Elastic Pools - List By Server

Reference

Service:: SQL Database

API Version:: 2014-04-01

Returns a list of elastic pools in a server.

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

URI Parameters

Name	In	Required	Type	Description
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	ElasticPoolListResult	OK

Examples

List elastic pools

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools?api-version=2014-04-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-2729",
      "name": "sqlcrudtest-2729",
      "type": "Microsoft.Sql/servers/elasticPools",
      "location": "Japan East",
      "kind": null,
      "properties": {
        "creationDate": "2017-02-10T01:27:21.32Z",
        "edition": "Basic",
        "state": "Ready",
        "dtu": 50,
        "databaseDtuMin": 0,
        "databaseDtuMax": 5,
        "storageMB": 5000
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-3191",
      "name": "sqlcrudtest-3191",
      "type": "Microsoft.Sql/servers/elasticPools",
      "location": "Japan East",
      "kind": null,
      "properties": {
        "creationDate": "2017-02-10T01:26:26.45Z",
        "edition": "Basic",
        "state": "Ready",
        "dtu": 50,
        "databaseDtuMin": 0,
        "databaseDtuMax": 5,
        "storageMB": 5000
      }
    },
    {
      "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,
      "properties": {
        "creationDate": "2017-02-10T01:25:25.033Z",
        "edition": "Basic",
        "state": "Ready",
        "dtu": 50,
        "databaseDtuMin": 0,
        "databaseDtuMax": 5,
        "storageMB": 5000
      }
    }
  ]
}

Definitions

Name	Description
ElasticPool	The list of elastic pools hosted in the server.
ElasticPoolEdition	The edition of the elastic pool.
ElasticPoolListResult	Represents the response to a list elastic pool request.
ElasticPoolState	The state of the elastic pool.

ElasticPool

The list of elastic pools hosted in the server.

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.databaseDtuMax	integer	The maximum DTU any one database can consume.
properties.databaseDtuMin	integer	The minimum DTU all databases are guaranteed.
properties.dtu	integer	The total shared DTU for the database elastic pool.
properties.edition	ElasticPoolEdition	The edition of the elastic pool.
properties.state	ElasticPoolState	The state of the elastic pool.
properties.storageMB	integer	Gets storage limit for the database elastic pool in MB.
properties.zoneRedundant	boolean	Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
tags	object	Resource tags.
type	string	Resource type.

ElasticPoolEdition

The edition of the elastic pool.

Name	Type	Description
Basic	string
BusinessCritical	string
GeneralPurpose	string
Premium	string
Standard	string

ElasticPoolListResult

Represents the response to a list elastic pool request.

Name	Type	Description
value	ElasticPool[]	The list of elastic pools hosted in the server.

ElasticPoolState

The state of the elastic pool.

Name	Type	Description
Creating	string
Disabled	string
Ready	string

Share via