azure-native.sql.getElasticPool
Explore with Pulumi AI
Gets an elastic pool. Azure REST API version: 2021-11-01.
Other available API versions: 2014-04-01, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-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:
- Elastic
Pool stringName - The name of the elastic pool.
- Resource
Group stringName - 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 string - The name of the server.
- Elastic
Pool stringName - The name of the elastic pool.
- Resource
Group stringName - 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 string - The name of the server.
- elastic
Pool StringName - The name of the elastic pool.
- resource
Group StringName - 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 String - The name of the server.
- elastic
Pool stringName - The name of the elastic pool.
- resource
Group stringName - 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 string - The name of the server.
- elastic_
pool_ strname - The name of the elastic pool.
- resource_
group_ strname - 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.
- elastic
Pool StringName - The name of the elastic pool.
- resource
Group StringName - 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 String - The name of the server.
getElasticPool Result
The following output properties are available:
- Creation
Date 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.
- High
Availability intReplica Count - The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
- License
Type string - The license type to apply for this elastic pool.
- Maintenance
Configuration stringId - Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
- Max
Size doubleBytes - The storage limit for the database elastic pool in bytes.
- Min
Capacity double - Minimal capacity that serverless pool will not shrink below, if not paused
- Per
Database Pulumi.Settings Azure Native. Sql. Outputs. Elastic Pool Per Database Settings Response - The per database settings for the elastic pool.
- Sku
Pulumi.
Azure Native. Sql. Outputs. Sku Response 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
- Dictionary<string, string>
- 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.
- Creation
Date 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.
- High
Availability intReplica Count - The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
- License
Type string - The license type to apply for this elastic pool.
- Maintenance
Configuration stringId - Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
- Max
Size float64Bytes - The storage limit for the database elastic pool in bytes.
- Min
Capacity float64 - Minimal capacity that serverless pool will not shrink below, if not paused
- Per
Database ElasticSettings Pool Per Database Settings Response - The per database settings for the elastic pool.
- Sku
Sku
Response 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
- map[string]string
- 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.
- creation
Date 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.
- high
Availability IntegerReplica Count - The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
- license
Type String - The license type to apply for this elastic pool.
- maintenance
Configuration StringId - Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
- max
Size DoubleBytes - The storage limit for the database elastic pool in bytes.
- min
Capacity Double - Minimal capacity that serverless pool will not shrink below, if not paused
- per
Database ElasticSettings Pool Per Database Settings Response - The per database settings for the elastic pool.
- sku
Sku
Response 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
- Map<String,String>
- Resource tags.
- zone
Redundant 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 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.
- high
Availability numberReplica Count - The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
- license
Type string - The license type to apply for this elastic pool.
- maintenance
Configuration stringId - Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
- max
Size numberBytes - The storage limit for the database elastic pool in bytes.
- min
Capacity number - Minimal capacity that serverless pool will not shrink below, if not paused
- per
Database ElasticSettings Pool Per Database Settings Response - The per database settings for the elastic pool.
- sku
Sku
Response 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
- {[key: string]: string}
- Resource tags.
- zone
Redundant 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.
- high_
availability_ intreplica_ count - The number of secondary replicas associated with the 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_ strid - Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
- max_
size_ floatbytes - 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_ Elasticsettings Pool Per Database Settings Response - The per database settings for the elastic pool.
- sku
Sku
Response 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
- 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.
- creation
Date 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.
- high
Availability NumberReplica Count - The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
- license
Type String - The license type to apply for this elastic pool.
- maintenance
Configuration StringId - Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
- max
Size NumberBytes - The storage limit for the database elastic pool in bytes.
- min
Capacity Number - Minimal capacity that serverless pool will not shrink below, if not paused
- per
Database Property MapSettings - The per database settings for 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
- Map<String>
- Resource tags.
- zone
Redundant 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
- Max
Capacity double - The maximum capacity any one database can consume.
- Min
Capacity double - The minimum capacity all databases are guaranteed.
- Max
Capacity float64 - The maximum capacity any one database can consume.
- Min
Capacity float64 - The minimum capacity all databases are guaranteed.
- max
Capacity Double - The maximum capacity any one database can consume.
- min
Capacity Double - The minimum capacity all databases are guaranteed.
- max
Capacity number - The maximum capacity any one database can consume.
- min
Capacity 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.
- max
Capacity Number - The maximum capacity any one database can consume.
- min
Capacity 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