Show / Hide Table of Contents

    Class ElasticPool

    An elastic pool.

    Inheritance
    Object
    Resource
    TrackedResource
    ElasticPool
    Inherited Members
    Resource.Id
    Resource.Name
    Resource.Type
    TrackedResource.Location
    TrackedResource.Tags
    Namespace: System.Dynamic.ExpandoObject
    Assembly: Microsoft.Azure.Management.Sql.dll
    Syntax
    [Microsoft.Rest.Serialization.JsonTransformation]
    public class ElasticPool : Microsoft.Azure.Management.Sql.Models.TrackedResource

    Constructors

    ElasticPool()

    Initializes a new instance of the ElasticPool class.

    Declaration
    public ElasticPool ();

    ElasticPool(String, String, String, String, IDictionary<String,String>, Sku, String, String, Nullable<DateTime>, Nullable<Int64>, ElasticPoolPerDatabaseSettings, Nullable<Boolean>, String)

    Initializes a new instance of the ElasticPool class.

    Declaration
    public ElasticPool (string location, string id = null, string name = null, string type = null, System.Collections.Generic.IDictionary<string,string> tags = null, Microsoft.Azure.Management.Sql.Models.Sku sku = null, string kind = null, string state = null, Nullable<DateTime> creationDate = null, Nullable<long> maxSizeBytes = null, Microsoft.Azure.Management.Sql.Models.ElasticPoolPerDatabaseSettings perDatabaseSettings = null, Nullable<bool> zoneRedundant = null, string licenseType = null);
    Parameters
    String location

    Resource location.

    String id

    Resource ID.

    String name

    Resource name.

    String type

    Resource type.

    IDictionary<String,String> tags

    Resource tags.

    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:
            
             ```azurecli
             az sql elastic-pool list-editions -l &lt;location&gt; -o table
             ````
    

    String kind

    Kind of elastic pool. This is metadata used for the Azure portal experience.

    String state

    The state of the elastic pool. Possible values include: 'Creating', 'Ready', 'Disabled'

    Nullable<DateTime> creationDate

    The creation date of the elastic pool (ISO8601 format).

    Nullable<Int64> maxSizeBytes

    The storage limit for the database elastic pool in bytes.

    ElasticPoolPerDatabaseSettings perDatabaseSettings

    The per database settings for the elastic pool.

    Nullable<Boolean> 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.

    String licenseType

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

    Properties

    CreationDate

    Gets the creation date of the elastic pool (ISO8601 format).

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.creationDate")]
    public Nullable<DateTime> CreationDate { get; }
    Property Value
    Nullable<DateTime>

    DatabaseDtuMax

    Gets or sets the maximum DTU any one database can consume.

    Declaration
    [Newtonsoft.Json.JsonIgnore]
    public Nullable<int> DatabaseDtuMax { get; set; }
    Property Value
    Nullable<Int32>

    DatabaseDtuMin

    Gets or sets the minimum DTU all databases are guaranteed.

    Declaration
    [Newtonsoft.Json.JsonIgnore]
    public Nullable<int> DatabaseDtuMin { get; set; }
    Property Value
    Nullable<Int32>

    Dtu

    Gets the total shared DTU for the database elastic pool.

    Declaration
    [Newtonsoft.Json.JsonIgnore]
    public Nullable<int> Dtu { get; }
    Property Value
    Nullable<Int32>

    Edition

    Gets or sets the edition of the elastic pool. Possible values include: 'Basic', 'Standard', 'Premium'

    Declaration
    [Newtonsoft.Json.JsonIgnore]
    public string Edition { get; }
    Property Value
    String

    Kind

    Gets kind of elastic pool. This is metadata used for the Azure portal experience.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="kind")]
    public string Kind { get; }
    Property Value
    String

    LicenseType

    Gets or sets the license type to apply for this elastic pool. Possible values include: 'LicenseIncluded', 'BasePrice'

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.licenseType")]
    public string LicenseType { get; set; }
    Property Value
    String

    MaxSizeBytes

    Gets or sets the storage limit for the database elastic pool in bytes.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.maxSizeBytes")]
    public Nullable<long> MaxSizeBytes { get; set; }
    Property Value
    Nullable<Int64>

    PerDatabaseSettings

    Gets or sets the per database settings for the elastic pool.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.perDatabaseSettings")]
    public Microsoft.Azure.Management.Sql.Models.ElasticPoolPerDatabaseSettings PerDatabaseSettings { get; set; }
    Property Value
    ElasticPoolPerDatabaseSettings

    Sku

    Gets or sets 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 &amp;lt;location&amp;gt; -o
    table
    
    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="sku")]
    public Microsoft.Azure.Management.Sql.Models.Sku Sku { get; set; }
    Property Value
    Sku

    State

    Gets the state of the elastic pool. Possible values include: 'Creating', 'Ready', 'Disabled'

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.state")]
    public string State { get; }
    Property Value
    String

    StorageMB

    Gets storage limit for the database elastic pool in MB.

    Declaration
    [Newtonsoft.Json.JsonIgnore]
    public Nullable<int> StorageMB { get; set; }
    Property Value
    Nullable<Int32>

    ZoneRedundant

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

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.zoneRedundant")]
    public Nullable<bool> ZoneRedundant { get; set; }
    Property Value
    Nullable<Boolean>

    Methods

    Validate()

    Validate the object.

    Declaration
    public override void Validate ();
    Exceptions
    ValidationException

    Thrown if validation fails

    Back to top Azure SDK for Net