Share via

ElasticPoolInner Class

  • Reference
Package:
com.azure.resourcemanager.sql.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-sql:2.44.0

public final class ElasticPoolInner
extends Resource

An elastic pool.

Constructor Summary

Constructor Description
ElasticPoolInner()

Creates an instance of ElasticPoolInner class.

Method Summary

Modifier and Type Method and Description
OffsetDateTime creationDate()

Get the creationDate property: The creation date of the elastic pool (ISO8601 format).
static ElasticPoolInner fromJson(JsonReader jsonReader)

Reads an instance of ElasticPoolInner from the JsonReader.
Integer highAvailabilityReplicaCount()

Get the highAvailabilityReplicaCount property: The number of secondary replicas associated with the elastic pool that are used to provide high availability.
String id()

Get the id property: Fully qualified resource Id for the resource.
String kind()

Get the kind property: Kind of elastic pool.
ElasticPoolLicenseType licenseType()

Get the licenseType property: The license type to apply for this elastic pool.
String maintenanceConfigurationId()

Get the maintenanceConfigurationId property: Maintenance configuration id assigned to the elastic pool.
Long maxSizeBytes()

Get the maxSizeBytes property: The storage limit for the database elastic pool in bytes.
Double minCapacity()

Get the minCapacity property: Minimal capacity that serverless pool will not shrink below, if not paused.
String name()

Get the name property: The name of the resource.
ElasticPoolPerDatabaseSettings perDatabaseSettings()

Get the perDatabaseSettings property: The per database settings for the elastic pool.
Sku sku()

Get the sku property: The elastic pool SKU.
ElasticPoolState state()

Get the state property: The state of the elastic pool.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
void validate()

Validates the instance.
ElasticPoolInner withHighAvailabilityReplicaCount(Integer highAvailabilityReplicaCount)

Set the highAvailabilityReplicaCount property: The number of secondary replicas associated with the elastic pool that are used to provide high availability.
ElasticPoolInner withLicenseType(ElasticPoolLicenseType licenseType)

Set the licenseType property: The license type to apply for this elastic pool.
ElasticPoolInner withLocation(String location)
ElasticPoolInner withMaintenanceConfigurationId(String maintenanceConfigurationId)

Set the maintenanceConfigurationId property: Maintenance configuration id assigned to the elastic pool.
ElasticPoolInner withMaxSizeBytes(Long maxSizeBytes)

Set the maxSizeBytes property: The storage limit for the database elastic pool in bytes.
ElasticPoolInner withMinCapacity(Double minCapacity)

Set the minCapacity property: Minimal capacity that serverless pool will not shrink below, if not paused.
ElasticPoolInner withPerDatabaseSettings(ElasticPoolPerDatabaseSettings perDatabaseSettings)

Set the perDatabaseSettings property: The per database settings for the elastic pool.
ElasticPoolInner withSku(Sku sku)

Set the sku property: The elastic pool SKU.
ElasticPoolInner withTags(Map<String,String> tags)
ElasticPoolInner withZoneRedundant(Boolean zoneRedundant)

Set the zoneRedundant property: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
Boolean zoneRedundant()

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

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ElasticPoolInner

public ElasticPoolInner()

Creates an instance of ElasticPoolInner class.

Method Details

creationDate

public OffsetDateTime creationDate()

Get the creationDate property: The creation date of the elastic pool (ISO8601 format).

Returns:

the creationDate value.

fromJson

public static ElasticPoolInner fromJson(JsonReader jsonReader)

Reads an instance of ElasticPoolInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ElasticPoolInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

highAvailabilityReplicaCount

public Integer highAvailabilityReplicaCount()

Get the highAvailabilityReplicaCount property: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

Returns:

the highAvailabilityReplicaCount value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ElasticPoolInner.id()

Returns:

the id value.

kind

public String kind()

Get the kind property: Kind of elastic pool. This is metadata used for the Azure portal experience.

Returns:

the kind value.

licenseType

public ElasticPoolLicenseType licenseType()

Get the licenseType property: The license type to apply for this elastic pool.

Returns:

the licenseType value.

maintenanceConfigurationId

public String maintenanceConfigurationId()

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

Returns:

the maintenanceConfigurationId value.

maxSizeBytes

public Long maxSizeBytes()

Get the maxSizeBytes property: The storage limit for the database elastic pool in bytes.

Returns:

the maxSizeBytes value.

minCapacity

public Double minCapacity()

Get the minCapacity property: Minimal capacity that serverless pool will not shrink below, if not paused.

Returns:

the minCapacity value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ElasticPoolInner.name()

Returns:

the name value.

perDatabaseSettings

public ElasticPoolPerDatabaseSettings perDatabaseSettings()

Get the perDatabaseSettings property: The per database settings for the elastic pool.

Returns:

the perDatabaseSettings value.

sku

public Sku sku()

Get the sku property: 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: ```azurecli az sql elastic-pool list-editions -l -o table ````.

Returns:

the sku value.

state

public ElasticPoolState state()

Get the state property: The state of the elastic pool.

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ElasticPoolInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ElasticPoolInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withHighAvailabilityReplicaCount

public ElasticPoolInner withHighAvailabilityReplicaCount(Integer highAvailabilityReplicaCount)

Set the highAvailabilityReplicaCount property: The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

Parameters:

highAvailabilityReplicaCount - the highAvailabilityReplicaCount value to set.

Returns:

the ElasticPoolInner object itself.

withLicenseType

public ElasticPoolInner withLicenseType(ElasticPoolLicenseType licenseType)

Set the licenseType property: The license type to apply for this elastic pool.

Parameters:

licenseType - the licenseType value to set.

Returns:

the ElasticPoolInner object itself.

withLocation

public ElasticPoolInner withLocation(String location)

Overrides:

ElasticPoolInner.withLocation(String location)

Parameters:

location

withMaintenanceConfigurationId

public ElasticPoolInner withMaintenanceConfigurationId(String maintenanceConfigurationId)

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

Parameters:

maintenanceConfigurationId - the maintenanceConfigurationId value to set.

Returns:

the ElasticPoolInner object itself.

withMaxSizeBytes

public ElasticPoolInner withMaxSizeBytes(Long maxSizeBytes)

Set the maxSizeBytes property: The storage limit for the database elastic pool in bytes.

Parameters:

maxSizeBytes - the maxSizeBytes value to set.

Returns:

the ElasticPoolInner object itself.

withMinCapacity

public ElasticPoolInner withMinCapacity(Double minCapacity)

Set the minCapacity property: Minimal capacity that serverless pool will not shrink below, if not paused.

Parameters:

minCapacity - the minCapacity value to set.

Returns:

the ElasticPoolInner object itself.

withPerDatabaseSettings

public ElasticPoolInner withPerDatabaseSettings(ElasticPoolPerDatabaseSettings perDatabaseSettings)

Set the perDatabaseSettings property: The per database settings for the elastic pool.

Parameters:

perDatabaseSettings - the perDatabaseSettings value to set.

Returns:

the ElasticPoolInner object itself.

withSku

public ElasticPoolInner withSku(Sku sku)

Set the sku property: 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: ```azurecli az sql elastic-pool list-editions -l -o table ````.

Parameters:

sku - the sku value to set.

Returns:

the ElasticPoolInner object itself.

withTags

public ElasticPoolInner withTags(Map tags)

Overrides:

ElasticPoolInner.withTags(Map<String,String> tags)

Parameters:

tags

withZoneRedundant

public ElasticPoolInner withZoneRedundant(Boolean zoneRedundant)

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

Parameters:

zoneRedundant - the zoneRedundant value to set.

Returns:

the ElasticPoolInner object itself.

zoneRedundant

public Boolean zoneRedundant()

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

Returns:

the zoneRedundant value.

Applies to