Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getElasticPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getElasticPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets an elastic pool.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2014-04-01, 2017-10-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Using getElasticPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getElasticPool(args: GetElasticPoolArgs, opts?: InvokeOptions): Promise<GetElasticPoolResult>
function getElasticPoolOutput(args: GetElasticPoolOutputArgs, opts?: InvokeOptions): Output<GetElasticPoolResult>
    def get_elastic_pool(elastic_pool_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     server_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetElasticPoolResult
def get_elastic_pool_output(elastic_pool_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     server_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetElasticPoolResult]
    func LookupElasticPool(ctx *Context, args *LookupElasticPoolArgs, opts ...InvokeOption) (*LookupElasticPoolResult, error)
func LookupElasticPoolOutput(ctx *Context, args *LookupElasticPoolOutputArgs, opts ...InvokeOption) LookupElasticPoolResultOutput

    > Note: This function is named LookupElasticPool in the Go SDK.

    public static class GetElasticPool 
{
    public static Task<GetElasticPoolResult> InvokeAsync(GetElasticPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticPoolResult> Invoke(GetElasticPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetElasticPoolResult> getElasticPool(GetElasticPoolArgs args, InvokeOptions options)
public static Output<GetElasticPoolResult> getElasticPool(GetElasticPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getElasticPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ElasticPoolName string
    The name of the elastic pool.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    ElasticPoolName string
    The name of the elastic pool.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    elasticPoolName String
    The name of the elastic pool.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    elasticPoolName string
    The name of the elastic pool.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName string
    The name of the server.
    elastic_pool_name str
    The name of the elastic pool.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    server_name str
    The name of the server.
    elasticPoolName String
    The name of the elastic pool.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.

    getElasticPool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    CreationDate string
    The creation date of the elastic pool (ISO8601 format).
    Id string
    Resource ID.
    Kind string
    Kind of elastic pool. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    Name string
    Resource name.
    State string
    The state of the elastic pool.
    Type string
    Resource type.
    AutoPauseDelay int
    Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
    AvailabilityZone string
    Specifies the availability zone the pool's primary replica is pinned to.
    HighAvailabilityReplicaCount int
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
    LicenseType string
    The license type to apply for this elastic pool.
    MaintenanceConfigurationId string
    Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
    MaxSizeBytes double
    The storage limit for the database elastic pool in bytes.
    MinCapacity double
    Minimal capacity that serverless pool will not shrink below, if not paused
    PerDatabaseSettings Pulumi.AzureNative.Sql.Outputs.ElasticPoolPerDatabaseSettingsResponse
    The per database settings for the elastic pool.
    PreferredEnclaveType string
    Type of enclave requested on the elastic pool.
    Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse

    The elastic pool SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:

    az sql elastic-pool list-editions -l <location> -o table
    Tags Dictionary<string, string>
    Resource tags.
    ZoneRedundant bool
    Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
    AzureApiVersion string
    The Azure API version of the resource.
    CreationDate string
    The creation date of the elastic pool (ISO8601 format).
    Id string
    Resource ID.
    Kind string
    Kind of elastic pool. This is metadata used for the Azure portal experience.
    Location string
    Resource location.
    Name string
    Resource name.
    State string
    The state of the elastic pool.
    Type string
    Resource type.
    AutoPauseDelay int
    Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
    AvailabilityZone string
    Specifies the availability zone the pool's primary replica is pinned to.
    HighAvailabilityReplicaCount int
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
    LicenseType string
    The license type to apply for this elastic pool.
    MaintenanceConfigurationId string
    Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
    MaxSizeBytes float64
    The storage limit for the database elastic pool in bytes.
    MinCapacity float64
    Minimal capacity that serverless pool will not shrink below, if not paused
    PerDatabaseSettings ElasticPoolPerDatabaseSettingsResponse
    The per database settings for the elastic pool.
    PreferredEnclaveType string
    Type of enclave requested on the elastic pool.
    Sku SkuResponse

    The elastic pool SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:

    az sql elastic-pool list-editions -l <location> -o table
    Tags map[string]string
    Resource tags.
    ZoneRedundant bool
    Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
    azureApiVersion String
    The Azure API version of the resource.
    creationDate String
    The creation date of the elastic pool (ISO8601 format).
    id String
    Resource ID.
    kind String
    Kind of elastic pool. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    name String
    Resource name.
    state String
    The state of the elastic pool.
    type String
    Resource type.
    autoPauseDelay Integer
    Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
    availabilityZone String
    Specifies the availability zone the pool's primary replica is pinned to.
    highAvailabilityReplicaCount Integer
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
    licenseType String
    The license type to apply for this elastic pool.
    maintenanceConfigurationId String
    Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
    maxSizeBytes Double
    The storage limit for the database elastic pool in bytes.
    minCapacity Double
    Minimal capacity that serverless pool will not shrink below, if not paused
    perDatabaseSettings ElasticPoolPerDatabaseSettingsResponse
    The per database settings for the elastic pool.
    preferredEnclaveType String
    Type of enclave requested on the elastic pool.
    sku SkuResponse

    The elastic pool SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:

    az sql elastic-pool list-editions -l <location> -o table
    tags Map<String,String>
    Resource tags.
    zoneRedundant Boolean
    Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
    azureApiVersion string
    The Azure API version of the resource.
    creationDate string
    The creation date of the elastic pool (ISO8601 format).
    id string
    Resource ID.
    kind string
    Kind of elastic pool. This is metadata used for the Azure portal experience.
    location string
    Resource location.
    name string
    Resource name.
    state string
    The state of the elastic pool.
    type string
    Resource type.
    autoPauseDelay number
    Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
    availabilityZone string
    Specifies the availability zone the pool's primary replica is pinned to.
    highAvailabilityReplicaCount number
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
    licenseType string
    The license type to apply for this elastic pool.
    maintenanceConfigurationId string
    Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
    maxSizeBytes number
    The storage limit for the database elastic pool in bytes.
    minCapacity number
    Minimal capacity that serverless pool will not shrink below, if not paused
    perDatabaseSettings ElasticPoolPerDatabaseSettingsResponse
    The per database settings for the elastic pool.
    preferredEnclaveType string
    Type of enclave requested on the elastic pool.
    sku SkuResponse

    The elastic pool SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:

    az sql elastic-pool list-editions -l <location> -o table
    tags {[key: string]: string}
    Resource tags.
    zoneRedundant boolean
    Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
    azure_api_version str
    The Azure API version of the resource.
    creation_date str
    The creation date of the elastic pool (ISO8601 format).
    id str
    Resource ID.
    kind str
    Kind of elastic pool. This is metadata used for the Azure portal experience.
    location str
    Resource location.
    name str
    Resource name.
    state str
    The state of the elastic pool.
    type str
    Resource type.
    auto_pause_delay int
    Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
    availability_zone str
    Specifies the availability zone the pool's primary replica is pinned to.
    high_availability_replica_count int
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
    license_type str
    The license type to apply for this elastic pool.
    maintenance_configuration_id str
    Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
    max_size_bytes float
    The storage limit for the database elastic pool in bytes.
    min_capacity float
    Minimal capacity that serverless pool will not shrink below, if not paused
    per_database_settings ElasticPoolPerDatabaseSettingsResponse
    The per database settings for the elastic pool.
    preferred_enclave_type str
    Type of enclave requested on the elastic pool.
    sku SkuResponse

    The elastic pool SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:

    az sql elastic-pool list-editions -l <location> -o table
    tags Mapping[str, str]
    Resource tags.
    zone_redundant bool
    Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
    azureApiVersion String
    The Azure API version of the resource.
    creationDate String
    The creation date of the elastic pool (ISO8601 format).
    id String
    Resource ID.
    kind String
    Kind of elastic pool. This is metadata used for the Azure portal experience.
    location String
    Resource location.
    name String
    Resource name.
    state String
    The state of the elastic pool.
    type String
    Resource type.
    autoPauseDelay Number
    Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
    availabilityZone String
    Specifies the availability zone the pool's primary replica is pinned to.
    highAvailabilityReplicaCount Number
    The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
    licenseType String
    The license type to apply for this elastic pool.
    maintenanceConfigurationId String
    Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
    maxSizeBytes Number
    The storage limit for the database elastic pool in bytes.
    minCapacity Number
    Minimal capacity that serverless pool will not shrink below, if not paused
    perDatabaseSettings Property Map
    The per database settings for the elastic pool.
    preferredEnclaveType String
    Type of enclave requested on the elastic pool.
    sku Property Map

    The elastic pool SKU.

    The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:

    az sql elastic-pool list-editions -l <location> -o table
    tags Map<String>
    Resource tags.
    zoneRedundant Boolean
    Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

    Supporting Types

    ElasticPoolPerDatabaseSettingsResponse

    AutoPauseDelay int
    Auto Pause Delay for per database within pool
    MaxCapacity double
    The maximum capacity any one database can consume.
    MinCapacity double
    The minimum capacity all databases are guaranteed.
    AutoPauseDelay int
    Auto Pause Delay for per database within pool
    MaxCapacity float64
    The maximum capacity any one database can consume.
    MinCapacity float64
    The minimum capacity all databases are guaranteed.
    autoPauseDelay Integer
    Auto Pause Delay for per database within pool
    maxCapacity Double
    The maximum capacity any one database can consume.
    minCapacity Double
    The minimum capacity all databases are guaranteed.
    autoPauseDelay number
    Auto Pause Delay for per database within pool
    maxCapacity number
    The maximum capacity any one database can consume.
    minCapacity number
    The minimum capacity all databases are guaranteed.
    auto_pause_delay int
    Auto Pause Delay for per database within pool
    max_capacity float
    The maximum capacity any one database can consume.
    min_capacity float
    The minimum capacity all databases are guaranteed.
    autoPauseDelay Number
    Auto Pause Delay for per database within pool
    maxCapacity Number
    The maximum capacity any one database can consume.
    minCapacity Number
    The minimum capacity all databases are guaranteed.

    SkuResponse

    Name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    Capacity int
    Capacity of the particular SKU.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    Size of the particular SKU
    Tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    Name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    Capacity int
    Capacity of the particular SKU.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    Size of the particular SKU
    Tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name String
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity Integer
    Capacity of the particular SKU.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    Size of the particular SKU
    tier String
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name string
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity number
    Capacity of the particular SKU.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    Size of the particular SKU
    tier string
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name str
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity int
    Capacity of the particular SKU.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    Size of the particular SKU
    tier str
    The tier or edition of the particular SKU, e.g. Basic, Premium.
    name String
    The name of the SKU, typically, a letter + Number code, e.g. P3.
    capacity Number
    Capacity of the particular SKU.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    Size of the particular SKU
    tier String
    The tier or edition of the particular SKU, e.g. Basic, Premium.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native