Azure Native v1.97.0, Mar 13 23

azure-native.sql.getElasticPool

Gets an elastic pool. API Version: 2020-11-01-preview.

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)
// Output-based functions aren't available in Java yet

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:

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.

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.

PerDatabaseSettings Pulumi.AzureNative.Sql.Outputs.ElasticPoolPerDatabaseSettingsResponse

The per database settings for 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.

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.

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.

PerDatabaseSettings ElasticPoolPerDatabaseSettingsResponse

The per database settings for the elastic pool.

Sku SkuResponse

The elastic pool SKU.

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.

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.

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.

perDatabaseSettings ElasticPoolPerDatabaseSettingsResponse

The per database settings for the elastic pool.

sku SkuResponse

The elastic pool SKU.

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.

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.

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.

perDatabaseSettings ElasticPoolPerDatabaseSettingsResponse

The per database settings for the elastic pool.

sku SkuResponse

The elastic pool SKU.

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.

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.

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.

per_database_settings ElasticPoolPerDatabaseSettingsResponse

The per database settings for the elastic pool.

sku SkuResponse

The elastic pool SKU.

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.

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.

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.

perDatabaseSettings Property Map

The per database settings for the elastic pool.

sku Property Map

The elastic pool SKU.

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

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 Double: The maximum capacity any one database can consume.
minCapacity Double: 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.

max_capacity float: The maximum capacity any one database can consume.
min_capacity float: 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.

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.sql.getElasticPool

Using getElasticPool

getElasticPool Result

Supporting Types

ElasticPoolPerDatabaseSettingsResponse

SkuResponse

Package Details

Contents