ElasticPool interface

An elastic pool.

Extends

Properties

creationDate

The creation date of the elastic pool (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

kind

Kind of elastic pool. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

licenseType

The license type to apply for this elastic pool. Possible values include: 'LicenseIncluded', 'BasePrice'

location

Resource location.

maxSizeBytes

The storage limit for the database elastic pool in bytes.

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

perDatabaseSettings

The per database settings for the elastic pool.

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
state

The state of the elastic pool. Possible values include: 'Creating', 'Ready', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

tags

Resource tags.

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

zoneRedundant

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

Property Details

creationDate

The creation date of the elastic pool (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

creationDate?: Date

Property Value

Date

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: undefined | string

Property Value

undefined | string

kind

Kind of elastic pool. This is metadata used for the Azure portal experience. NOTE: This property will not be serialized. It can only be populated by the server.

kind?: undefined | string

Property Value

undefined | string

licenseType

The license type to apply for this elastic pool. Possible values include: 'LicenseIncluded', 'BasePrice'

licenseType?: ElasticPoolLicenseType

Property Value

location

Resource location.

location: string

Property Value

string

maxSizeBytes

The storage limit for the database elastic pool in bytes.

maxSizeBytes?: undefined | number

Property Value

undefined | number

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: undefined | string

Property Value

undefined | string

perDatabaseSettings

The per database settings for the elastic pool.

perDatabaseSettings?: ElasticPoolPerDatabaseSettings

Property Value

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
sku?: Sku

Property Value

Sku

state

The state of the elastic pool. Possible values include: 'Creating', 'Ready', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

state?: ElasticPoolState

Property Value

tags

Resource tags.

tags?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: undefined | string

Property Value

undefined | string

zoneRedundant

Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.

zoneRedundant?: undefined | false | true

Property Value

undefined | false | true