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' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    databaseDtuMax: int
    databaseDtuMin: int
    dtu: int
    edition: 'string'
    storageMB: int
    zoneRedundant: bool
  }
}

Property values

servers/elasticPools

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-128

Valid characters:
Can't use:
<>*%&:\/? or control characters

Can't end with period or space.
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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

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

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.

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",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "databaseDtuMax": "int",
    "databaseDtuMin": "int",
    "dtu": "int",
    "edition": "string",
    "storageMB": "int",
    "zoneRedundant": "bool"
  }
}

Property values

servers/elasticPools

Name Description Value
type The resource type 'Microsoft.Sql/servers/elasticPools'
apiVersion The resource api version '2014-04-01'
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 characters

Can't end with period or space.
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties The properties representing the resource. ElasticPoolProperties

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

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"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      databaseDtuMax = int
      databaseDtuMin = int
      dtu = int
      edition = "string"
      storageMB = int
      zoneRedundant = bool
    }
  })
}

Property values

servers/elasticPools

Name Description Value
type The resource type "Microsoft.Sql/servers/elasticPools@2014-04-01"
name The resource name string (required)

Character limit: 1-128

Valid characters:
Can't use:
<>*%&:\/? or control characters

Can't end with period or space.
location Resource location. string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
tags Resource tags. Dictionary of tag names and values.
properties The properties representing the resource. ElasticPoolProperties

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