ElasticPool

Allows you to manage an Azure SQL Elastic Pool via the v3.0 API which allows for vCore and DTU based configurations.

Create a ElasticPool Resource

new ElasticPool(name: string, args: ElasticPoolArgs, opts?: CustomResourceOptions);

def ElasticPool(resource_name, opts=None, license_type=None, location=None, max_size_bytes=None, max_size_gb=None, name=None, per_database_settings=None, resource_group_name=None, server_name=None, sku=None, tags=None, zone_redundant=None, __props__=None);

func NewElasticPool(ctx *Context, name string, args ElasticPoolArgs, opts ...ResourceOption) (*ElasticPool, error)

public ElasticPool(string name, ElasticPoolArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ElasticPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ElasticPoolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ElasticPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ElasticPool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ElasticPool resource accepts the following input properties:

PerDatabaseSettings ElasticPoolPerDatabaseSettingsArgs: A per_database_settings block as defined below.
ResourceGroupName string: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
ServerName string: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
Sku ElasticPoolSkuArgs: A sku block as defined below.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes int: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
MaxSizeGb double: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
Name string: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
ZoneRedundant bool: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

PerDatabaseSettings ElasticPoolPerDatabaseSettings: A per_database_settings block as defined below.
ResourceGroupName string: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
ServerName string: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
Sku ElasticPoolSku: A sku block as defined below.
LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes int: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
MaxSizeGb float64: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
Name string: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
ZoneRedundant bool: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

perDatabaseSettings ElasticPoolPerDatabaseSettings: A per_database_settings block as defined below.
resourceGroupName string: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
serverName string: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
sku ElasticPoolSku: A sku block as defined below.
licenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maxSizeBytes number: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
maxSizeGb number: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
name string: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
zoneRedundant boolean: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

per_database_settings Dict[ElasticPoolPerDatabaseSettings]: A per_database_settings block as defined below.
resource_group_name str: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
server_name str: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
sku Dict[ElasticPoolSku]: A sku block as defined below.
license_type str: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
max_size_bytes float: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
max_size_gb float: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
name str: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
zone_redundant bool: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the ElasticPool resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ElasticPool Resource

Get an existing ElasticPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ElasticPoolState, opts?: CustomResourceOptions): ElasticPool

static get(resource_name, id, opts=None, license_type=None, location=None, max_size_bytes=None, max_size_gb=None, name=None, per_database_settings=None, resource_group_name=None, server_name=None, sku=None, tags=None, zone_redundant=None, __props__=None);

func GetElasticPool(ctx *Context, name string, id IDInput, state *ElasticPoolState, opts ...ResourceOption) (*ElasticPool, error)

public static ElasticPool Get(string name, Input<string> id, ElasticPoolState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes int: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
MaxSizeGb double: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
Name string: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
PerDatabaseSettings ElasticPoolPerDatabaseSettingsArgs: A per_database_settings block as defined below.
ResourceGroupName string: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
ServerName string: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
Sku ElasticPoolSkuArgs: A sku block as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
ZoneRedundant bool: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

LicenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MaxSizeBytes int: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
MaxSizeGb float64: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
Name string: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
PerDatabaseSettings ElasticPoolPerDatabaseSettings: A per_database_settings block as defined below.
ResourceGroupName string: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
ServerName string: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
Sku ElasticPoolSku: A sku block as defined below.
Tags map[string]string: A mapping of tags to assign to the resource.
ZoneRedundant bool: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

licenseType string: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
maxSizeBytes number: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
maxSizeGb number: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
name string: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
perDatabaseSettings ElasticPoolPerDatabaseSettings: A per_database_settings block as defined below.
resourceGroupName string: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
serverName string: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
sku ElasticPoolSku: A sku block as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
zoneRedundant boolean: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

license_type str: Specifies the license type applied to this database. Possible values are LicenseIncluded and BasePrice.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
max_size_bytes float: The max data size of the elastic pool in bytes. Conflicts with max_size_gb.
max_size_gb float: The max data size of the elastic pool in gigabytes. Conflicts with max_size_bytes.
name str: The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.
per_database_settings Dict[ElasticPoolPerDatabaseSettings]: A per_database_settings block as defined below.
resource_group_name str: The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.
server_name str: The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.
sku Dict[ElasticPoolSku]: A sku block as defined below.
tags Dict[str, str]: A mapping of tags to assign to the resource.
zone_redundant bool: Whether or not this elastic pool is zone redundant. tier needs to be Premium for DTU based or BusinessCritical for vCore based sku. Defaults to false.

Supporting Types

ElasticPoolPerDatabaseSettings

See the input and output API doc for this type.

MaxCapacity double: The maximum capacity any one database can consume.
MinCapacity double: The minimum capacity all databases are guaranteed.

MaxCapacity float64: The maximum capacity any one database can consume.
MinCapacity float64: The minimum capacity all databases are guaranteed.

maxCapacity number: The maximum capacity any one database can consume.
minCapacity number: The minimum capacity all databases are guaranteed.

maxCapacity float: The maximum capacity any one database can consume.
min_capacity float: The minimum capacity all databases are guaranteed.

ElasticPoolSku

See the input and output API doc for this type.

Capacity int: The scale up/out capacity, representing server’s compute units. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
Name string: Specifies the SKU Name for this Elasticpool. The name of the SKU, will be either vCore based tier + family pattern (e.g. GP_Gen4, BC_Gen5) or the DTU based BasicPool, StandardPool, or PremiumPool pattern.
Tier string: The tier of the particular SKU. Possible values are GeneralPurpose, BusinessCritical, Basic, Standard, or Premium. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
Family string: The family of hardware Gen4 or Gen5.

Capacity int: The scale up/out capacity, representing server’s compute units. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
Name string: Specifies the SKU Name for this Elasticpool. The name of the SKU, will be either vCore based tier + family pattern (e.g. GP_Gen4, BC_Gen5) or the DTU based BasicPool, StandardPool, or PremiumPool pattern.
Tier string: The tier of the particular SKU. Possible values are GeneralPurpose, BusinessCritical, Basic, Standard, or Premium. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
Family string: The family of hardware Gen4 or Gen5.

capacity number: The scale up/out capacity, representing server’s compute units. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
name string: Specifies the SKU Name for this Elasticpool. The name of the SKU, will be either vCore based tier + family pattern (e.g. GP_Gen4, BC_Gen5) or the DTU based BasicPool, StandardPool, or PremiumPool pattern.
tier string: The tier of the particular SKU. Possible values are GeneralPurpose, BusinessCritical, Basic, Standard, or Premium. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
family string: The family of hardware Gen4 or Gen5.

capacity float: The scale up/out capacity, representing server’s compute units. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
name str: Specifies the SKU Name for this Elasticpool. The name of the SKU, will be either vCore based tier + family pattern (e.g. GP_Gen4, BC_Gen5) or the DTU based BasicPool, StandardPool, or PremiumPool pattern.
tier str: The tier of the particular SKU. Possible values are GeneralPurpose, BusinessCritical, Basic, Standard, or Premium. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.
family str: The family of hardware Gen4 or Gen5.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud