ElasticPool Class

An elastic pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

ElasticPool(*, location: str, tags: dict[str, str] | None = None, sku: _models.Sku | None = None, max_size_bytes: int | None = None, min_capacity: float | None = None, per_database_settings: _models.ElasticPoolPerDatabaseSettings | None = None, zone_redundant: bool | None = None, license_type: str | _models.ElasticPoolLicenseType | None = None, maintenance_configuration_id: str | None = None, high_availability_replica_count: int | None = None, preferred_enclave_type: str | _models.AlwaysEncryptedEnclaveType | None = None, availability_zone: str | _models.AvailabilityZoneType | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags. Default value: None
sku	Sku 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 `. Default value: None
max_size_bytes	int The storage limit for the database elastic pool in bytes. Default value: None
min_capacity	float Minimal capacity that serverless pool will not shrink below, if not paused. Default value: None
per_database_settings	ElasticPoolPerDatabaseSettings The per database settings for the elastic pool. Default value: None
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. Default value: None
license_type	str or ElasticPoolLicenseType The license type to apply for this elastic pool. Known values are: "LicenseIncluded" and "BasePrice". Default value: None
maintenance_configuration_id	str Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. Default value: None
high_availability_replica_count	int The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. Default value: None
preferred_enclave_type	str or AlwaysEncryptedEnclaveType Type of enclave requested on the elastic pool. Known values are: "Default" and "VBS". Default value: None
availability_zone	str or AvailabilityZoneType Specifies the availability zone the pool's primary replica is pinned to. Known values are: "NoPreference", "1", "2", and "3". Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
sku	Sku 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 `.
kind	str Kind of elastic pool. This is metadata used for the Azure portal experience.
state	str or ElasticPoolState The state of the elastic pool. Known values are: "Creating", "Ready", and "Disabled".
creation_date	datetime The creation date of the elastic pool (ISO8601 format).
max_size_bytes	int 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	ElasticPoolPerDatabaseSettings The per database settings for the elastic pool.
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.
license_type	str or ElasticPoolLicenseType The license type to apply for this elastic pool. Known values are: "LicenseIncluded" and "BasePrice".
maintenance_configuration_id	str Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
high_availability_replica_count	int The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
preferred_enclave_type	str or AlwaysEncryptedEnclaveType Type of enclave requested on the elastic pool. Known values are: "Default" and "VBS".
availability_zone	str or AvailabilityZoneType Specifies the availability zone the pool's primary replica is pinned to. Known values are: "NoPreference", "1", "2", and "3".