Package version:

Interface ElasticPool

An elastic pool.

Hierarchy

Properties

creationDate? highAvailabilityReplicaCount? id? kind? licenseType? location maintenanceConfigurationId? maxSizeBytes? name? perDatabaseSettings? sku? state? tags? type? zoneRedundant?

Properties

Optional Readonly creationDate

creationDate?: Date

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

Optional highAvailabilityReplicaCount

highAvailabilityReplicaCount?: number

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

Optional Readonly id

id?: string

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

Optional Readonly kind

kind?: string

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.

Optional licenseType

licenseType?: string

The license type to apply for this elastic pool.

location

location: string

Resource location.

Optional maintenanceConfigurationId

maintenanceConfigurationId?: string

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

Optional maxSizeBytes

maxSizeBytes?: number

The storage limit for the database elastic pool in bytes.

Optional Readonly name

name?: string

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

Optional perDatabaseSettings

perDatabaseSettings?: ElasticPoolPerDatabaseSettings

The per database settings for the elastic pool.

Optional sku

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

Optional Readonly state

state?: string

The state of the elastic pool. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

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

Resource tags.

Type declaration

  • [propertyName: string]: string

Optional Readonly type

type?: string

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

Optional zoneRedundant

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.

Settings

Member Visibility

Theme

Generated using TypeDoc