Microsoft.Sql servers/elasticPools template reference

Template format

To create a Microsoft.Sql/servers/elasticPools resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Sql/servers/elasticPools",
  "apiVersion": "2017-10-01-preview",
  "location": "string",
  "tags": {},
  "sku": {
    "name": "string",
    "tier": "string",
    "size": "string",
    "family": "string",
    "capacity": "integer"
  },
  "properties": {
    "maxSizeBytes": "integer",
    "perDatabaseSettings": {
      "minCapacity": "number",
      "maxCapacity": "number"
    },
    "zoneRedundant": "boolean",
    "licenseType": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Sql/servers/elasticPools object

Name Type Required Value
name string Yes The name of the elastic pool to be operated on (updated or created).
type enum Yes elasticPools
-or-
Microsoft.Sql/servers/elasticPools

See Set name and type for child resources.
apiVersion enum Yes 2017-10-01-preview
location string Yes Resource location.
tags object No Resource tags.
sku object No 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 - Sku object
properties object Yes Resource properties. - ElasticPoolProperties object

Sku object

Name Type Required Value
name string Yes The name of the SKU, typically, a letter + Number code, e.g. P3.
tier string No The tier or edition of the particular SKU, e.g. Basic, Premium.
size string No Size of the particular SKU
family string No If the service has different generations of hardware, for the same SKU, then that can be captured here.
capacity integer No Capacity of the particular SKU.

ElasticPoolProperties object

Name Type Required Value
maxSizeBytes integer No The storage limit for the database elastic pool in bytes.
perDatabaseSettings object No The per database settings for the elastic pool. - ElasticPoolPerDatabaseSettings object
zoneRedundant boolean No Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
licenseType enum No The license type to apply for this elastic pool. - LicenseIncluded or BasePrice

ElasticPoolPerDatabaseSettings object

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

Quickstart templates

The following quickstart templates deploy this resource type.