Share via

Microsoft.Sql instancePools 2022-05-01-preview

  • Article

Bicep resource definition

The instancePools 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/instancePools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/instancePools@2022-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  properties: {
    licenseType: 'string'
    subnetId: 'string'
    vCores: int
  }
}

Property values

instancePools

Name Description Value
name The resource name string (required)
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The name and tier of the SKU. Sku
properties Resource properties. InstancePoolProperties

InstancePoolProperties

Name Description Value
licenseType The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). 'BasePrice'
'LicenseIncluded' (required)
subnetId Resource ID of the subnet to place this instance pool in. string (required)
vCores Count of vCores belonging to this instance pool. int (required)

Sku

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

ARM template resource definition

The instancePools 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/instancePools resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/instancePools",
  "apiVersion": "2022-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "licenseType": "string",
    "subnetId": "string",
    "vCores": "int"
  }
}

Property values

instancePools

Name Description Value
type The resource type 'Microsoft.Sql/instancePools'
apiVersion The resource api version '2022-05-01-preview'
name The resource name string (required)
location Resource location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The name and tier of the SKU. Sku
properties Resource properties. InstancePoolProperties

InstancePoolProperties

Name Description Value
licenseType The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). 'BasePrice'
'LicenseIncluded' (required)
subnetId Resource ID of the subnet to place this instance pool in. string (required)
vCores Count of vCores belonging to this instance pool. int (required)

Sku

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

Terraform (AzAPI provider) resource definition

The instancePools 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/instancePools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/instancePools@2022-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      licenseType = "string"
      subnetId = "string"
      vCores = int
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

Property values

instancePools

Name Description Value
type The resource type "Microsoft.Sql/instancePools@2022-05-01-preview"
name The resource name string (required)
location Resource location. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku The name and tier of the SKU. Sku
properties Resource properties. InstancePoolProperties

InstancePoolProperties

Name Description Value
licenseType The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). "BasePrice"
"LicenseIncluded" (required)
subnetId Resource ID of the subnet to place this instance pool in. string (required)
vCores Count of vCores belonging to this instance pool. int (required)

Sku

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