ElasticPoolProperties interface
Properties of an elastic pool
Properties
| auto |
Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled |
| availability |
Specifies the availability zone the pool's primary replica is pinned to. |
| creation |
The creation date of the elastic pool (ISO8601 format). |
| high |
The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. |
| license |
The license type to apply for this elastic pool. |
| maintenance |
Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. |
| max |
The storage limit for the database elastic pool in bytes. |
| min |
Minimal capacity that serverless pool will not shrink below, if not paused |
| per |
The per database settings for the elastic pool. |
| preferred |
Type of enclave requested on the elastic pool. |
| state | The state of the elastic pool. |
| zone |
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
autoPauseDelay
Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
autoPauseDelay?: numberProperty Value
number
availabilityZone
Specifies the availability zone the pool's primary replica is pinned to.
availabilityZone?: stringProperty Value
string
creationDate
The creation date of the elastic pool (ISO8601 format).
creationDate?: DateProperty Value
Date
highAvailabilityReplicaCount
The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
highAvailabilityReplicaCount?: numberProperty Value
number
licenseType
The license type to apply for this elastic pool.
licenseType?: stringProperty Value
string
maintenanceConfigurationId
Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
maintenanceConfigurationId?: stringProperty Value
string
maxSizeBytes
The storage limit for the database elastic pool in bytes.
maxSizeBytes?: numberProperty Value
number
minCapacity
Minimal capacity that serverless pool will not shrink below, if not paused
minCapacity?: numberProperty Value
number
perDatabaseSettings
The per database settings for the elastic pool.
perDatabaseSettings?: ElasticPoolPerDatabaseSettingsProperty Value
preferredEnclaveType
Type of enclave requested on the elastic pool.
preferredEnclaveType?: stringProperty Value
string
state
The state of the elastic pool.
state?: stringProperty 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?: booleanProperty Value
boolean