Skip to content

Data Source: azurermMssqlElasticpool

Use this data source to access information about an existing SQL elastic pool.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermMssqlElasticpoolExample =
  new azurerm.dataAzurermMssqlElasticpool.DataAzurermMssqlElasticpool(
    this,
    "example",
    {
      name: "mssqlelasticpoolname",
      resource_group_name: "example-resources",
      server_name: "example-sql-server",
    }
  );
new cdktf.TerraformOutput(this, "elasticpool_id", {
  value: dataAzurermMssqlElasticpoolExample.id,
});

Argument Reference

  • name - The name of the elastic pool.

  • resourceGroupName - The name of the resource group which contains the elastic pool.

  • serverName - The name of the SQL Server which contains the elastic pool.

Attributes Reference

  • licenseType - The license type to apply for this database.

  • location - Specifies the supported Azure location where the resource exists.

  • maxSizeGb - The max data size of the elastic pool in gigabytes.

  • maxSizeBytes - The max data size of the elastic pool in bytes.

  • perDbMinCapacity - The minimum capacity all databases are guaranteed.

  • perDbMaxCapacity - The maximum capacity any one database can consume.

  • sku - A sku block as defined below.

  • tags - A mapping of tags to assign to the resource.

  • zoneRedundant - Whether or not this elastic pool is zone redundant.

sku exports the following:

  • name - Specifies the SKU Name for this Elasticpool.

  • capacity - The scale up/out capacity, representing server's compute units.

  • tier - The tier of the particular SKU.

  • family - The family of hardware.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the SQL elastic pool.