1. Docs
  2. Reference
  3. API
  4. Azure
  5. sql
  6. ElasticPool

ElasticPool

Allows you to manage an Azure SQL Elastic Pool.

NOTE: - This version of the Elasticpool resource is being deprecated and should no longer be used. Please use the azure.mssql.ElasticPool version instead.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleSqlServer = new Azure.Sql.SqlServer("exampleSqlServer", new Azure.Sql.SqlServerArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Version = "12.0",
            AdministratorLogin = "4dm1n157r470r",
            AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
        });
        var exampleElasticPool = new Azure.Sql.ElasticPool("exampleElasticPool", new Azure.Sql.ElasticPoolArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            ServerName = exampleSqlServer.Name,
            Edition = "Basic",
            Dtu = 50,
            DbDtuMin = 0,
            DbDtuMax = 5,
            PoolSize = 5000,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/sql"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        exampleSqlServer, err := sql.NewSqlServer(ctx, "exampleSqlServer", &sql.SqlServerArgs{
            ResourceGroupName:          exampleResourceGroup.Name,
            Location:                   exampleResourceGroup.Location,
            Version:                    pulumi.String("12.0"),
            AdministratorLogin:         pulumi.String("4dm1n157r470r"),
            AdministratorLoginPassword: pulumi.String("4-v3ry-53cr37-p455w0rd"),
        })
        if err != nil {
            return err
        }
        _, err = sql.NewElasticPool(ctx, "exampleElasticPool", &sql.ElasticPoolArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            ServerName:        exampleSqlServer.Name,
            Edition:           pulumi.String("Basic"),
            Dtu:               pulumi.Int(50),
            DbDtuMin:          pulumi.Int(0),
            DbDtuMax:          pulumi.Int(5),
            PoolSize:          pulumi.Int(5000),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_sql_server = azure.sql.SqlServer("exampleSqlServer",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    version="12.0",
    administrator_login="4dm1n157r470r",
    administrator_login_password="4-v3ry-53cr37-p455w0rd")
example_elastic_pool = azure.sql.ElasticPool("exampleElasticPool",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    server_name=example_sql_server.name,
    edition="Basic",
    dtu=50,
    db_dtu_min=0,
    db_dtu_max=5,
    pool_size=5000)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleSqlServer = new azure.sql.SqlServer("exampleSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const exampleElasticPool = new azure.sql.ElasticPool("exampleElasticPool", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serverName: exampleSqlServer.name,
    edition: "Basic",
    dtu: 50,
    dbDtuMin: 0,
    dbDtuMax: 5,
    poolSize: 5000,
});

Create a ElasticPool Resource

new ElasticPool(name: string, args: ElasticPoolArgs, opts?: CustomResourceOptions);
def ElasticPool(resource_name, opts=None, db_dtu_max=None, db_dtu_min=None, dtu=None, edition=None, location=None, name=None, pool_size=None, resource_group_name=None, server_name=None, tags=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:

Dtu int

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

Edition string

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

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.

DbDtuMax int

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

DbDtuMin int

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

PoolSize int

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

Dtu int

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

Edition string

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

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.

DbDtuMax int

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

DbDtuMin int

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

PoolSize int

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

Tags map[string]string

A mapping of tags to assign to the resource.

dtu number

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

edition string

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

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.

dbDtuMax number

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

dbDtuMin number

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

poolSize number

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

dtu float

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

edition str

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

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.

db_dtu_max float

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

db_dtu_min float

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

pool_size float

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

tags Dict[str, str]

A mapping of tags to assign to the resource.

Outputs

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

CreationDate string

The creation date of the SQL Elastic Pool.

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

The creation date of the SQL Elastic Pool.

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

The creation date of the SQL Elastic Pool.

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

The creation date of the SQL Elastic Pool.

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, creation_date=None, db_dtu_max=None, db_dtu_min=None, dtu=None, edition=None, location=None, name=None, pool_size=None, resource_group_name=None, server_name=None, tags=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:

CreationDate string

The creation date of the SQL Elastic Pool.

DbDtuMax int

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

DbDtuMin int

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

Dtu int

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

Edition string

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

PoolSize int

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

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.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

CreationDate string

The creation date of the SQL Elastic Pool.

DbDtuMax int

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

DbDtuMin int

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

Dtu int

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

Edition string

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

Location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Name string

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

PoolSize int

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

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.

Tags map[string]string

A mapping of tags to assign to the resource.

creationDate string

The creation date of the SQL Elastic Pool.

dbDtuMax number

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

dbDtuMin number

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

dtu number

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

edition string

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

location string

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name string

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

poolSize number

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

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.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

creation_date str

The creation date of the SQL Elastic Pool.

db_dtu_max float

The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.

db_dtu_min float

The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.

dtu float

The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.

edition str

The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.

location str

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name str

The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.

pool_size float

The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.

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.

tags Dict[str, str]

A mapping of tags to assign to the resource.

Package Details

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