The servers/elasticPools resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Sql/servers/elasticPools resource, add the following JSON to your template.
{
"type": "Microsoft.Sql/servers/elasticPools",
"apiVersion": "2023-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"properties": {
"autoPauseDelay": "int",
"availabilityZone": "string",
"highAvailabilityReplicaCount": "int",
"licenseType": "string",
"maintenanceConfigurationId": "string",
"maxSizeBytes": "int",
"minCapacity": "int",
"perDatabaseSettings": {
"autoPauseDelay": "int",
"maxCapacity": "int",
"minCapacity": "int"
},
"preferredEnclaveType": "string",
"zoneRedundant": "bool"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Sql/servers/elasticPools' |
apiVersion | The resource api version | '2023-05-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:\/? or control charactersCan't end with period or space. |
location | Resource location. | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
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:Azure CLI: az sql elastic-pool list-editions -l {location} -o table |
Sku |
properties | Resource properties. | ElasticPoolProperties |
Name | Description | Value |
---|---|---|
autoPauseDelay | Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled | int |
availabilityZone | Specifies the availability zone the pool's primary replica is pinned to. | '1' '2' '3' 'NoPreference' |
highAvailabilityReplicaCount | The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. | int |
licenseType | The license type to apply for this elastic pool. | 'BasePrice' 'LicenseIncluded' |
maintenanceConfigurationId | Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. | string |
maxSizeBytes | The storage limit for the database elastic pool in bytes. | int |
minCapacity | Minimal capacity that serverless pool will not shrink below, if not paused | int |
perDatabaseSettings | The per database settings for the elastic pool. | ElasticPoolPerDatabaseSettings |
preferredEnclaveType | Type of enclave requested on the elastic pool. | 'Default' 'VBS' |
zoneRedundant | Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. | bool |
Name | Description | Value |
---|---|---|
autoPauseDelay | Auto Pause Delay for per database within pool | int |
maxCapacity | The maximum capacity any one database can consume. | int |
minCapacity | The minimum capacity all databases are guaranteed. | int |
Name | Description | Value |
---|---|---|
capacity | Capacity of the particular SKU. | int |
family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
size | Size of the particular SKU | string |
tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | string |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Deploy a new SQL Elastic Pool |
This template allows you to deploy a new SQL Elastic Pool with its new associated SQL Server and new SQL Databases to assign to it. |