Share via

Microsoft.Sql servers/elasticPools 2014-04-01

  • Article

Bicep resource definition

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.

Resource format

To create a Microsoft.Sql/servers/elasticPools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/elasticPools@2014-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    databaseDtuMax: int
    databaseDtuMin: int
    dtu: int
    edition: 'string'
    storageMB: int
    zoneRedundant: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ElasticPoolProperties

Name Description Value
databaseDtuMax The maximum DTU any one database can consume. int
databaseDtuMin The minimum DTU all databases are guaranteed. int
dtu The total shared DTU for the database elastic pool. int
edition The edition of the elastic pool. 'Basic'
'BusinessCritical'
'GeneralPurpose'
'Premium'
'Standard'
storageMB Gets storage limit for the database elastic pool in MB. int
zoneRedundant Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones. bool

Microsoft.Sql/servers/elasticPools

Name Description Value
location Resource location. string (required)
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: servers
properties The properties representing the resource. ElasticPoolProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

ARM template resource definition

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.

Resource format

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

{
  "type": "Microsoft.Sql/servers/elasticPools",
  "apiVersion": "2014-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "databaseDtuMax": "int",
    "databaseDtuMin": "int",
    "dtu": "int",
    "edition": "string",
    "storageMB": "int",
    "zoneRedundant": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ElasticPoolProperties

Name Description Value
databaseDtuMax The maximum DTU any one database can consume. int
databaseDtuMin The minimum DTU all databases are guaranteed. int
dtu The total shared DTU for the database elastic pool. int
edition The edition of the elastic pool. 'Basic'
'BusinessCritical'
'GeneralPurpose'
'Premium'
'Standard'
storageMB Gets storage limit for the database elastic pool in MB. int
zoneRedundant Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones. bool

Microsoft.Sql/servers/elasticPools

Name Description Value
apiVersion The api version '2014-04-01'
location Resource location. string (required)
name The resource name string (required)
properties The properties representing the resource. ElasticPoolProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Sql/servers/elasticPools'

TrackedResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy a new SQL Elastic Pool

Deploy to Azure		 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.

Terraform (AzAPI provider) resource definition

The servers/elasticPools resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/elasticPools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/elasticPools@2014-04-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      databaseDtuMax = int
      databaseDtuMin = int
      dtu = int
      edition = "string"
      storageMB = int
      zoneRedundant = bool
    }
  })
}

Property values

ElasticPoolProperties

Name Description Value
databaseDtuMax The maximum DTU any one database can consume. int
databaseDtuMin The minimum DTU all databases are guaranteed. int
dtu The total shared DTU for the database elastic pool. int
edition The edition of the elastic pool. 'Basic'
'BusinessCritical'
'GeneralPurpose'
'Premium'
'Standard'
storageMB Gets storage limit for the database elastic pool in MB. int
zoneRedundant Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones. bool

Microsoft.Sql/servers/elasticPools

Name Description Value
location Resource location. string (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
properties The properties representing the resource. ElasticPoolProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Sql/servers/elasticPools@2014-04-01"

TrackedResourceTags

Name Description Value