ElasticPool interface

Package:

@azure/arm-sql

An elastic pool.

Extends

TrackedResource

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.
highAvailabilityReplicaCount	The number of secondary replicas associated with the elastic pool that are used to provide high availability.
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.
maintenanceConfigurationId	Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
maxSizeBytes	The storage limit for the database elastic pool in bytes.
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. 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.

Inherited Properties

id	Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location.
name	Resource name. 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.

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

highAvailabilityReplicaCount

The number of secondary replicas associated with the elastic pool that are used to provide high availability.

highAvailabilityReplicaCount?: number

Property Value

number

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?: string

Property Value

string

licenseType

The license type to apply for this elastic pool.

licenseType?: string

Property Value

string

maintenanceConfigurationId

Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

maintenanceConfigurationId?: string

Property Value

string

maxSizeBytes

The storage limit for the database elastic pool in bytes.

maxSizeBytes?: number

Property Value

number

perDatabaseSettings

The per database settings for the elastic pool.

perDatabaseSettings?: ElasticPoolPerDatabaseSettings

Property Value

ElasticPoolPerDatabaseSettings

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. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

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?: boolean

Property Value

boolean

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Resource location.

location: string

Property Value

string

Inherited From TrackedResource.location

name

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

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type