Class Database

A database resource.

Inheritance
Object
Resource
TrackedResource
Database
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Sql.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class Database : Microsoft.Azure.Management.Sql.Models.TrackedResource

Constructors

Database()

Initializes a new instance of the Database class.

Declaration
public Database ();

Database(String, String, String, String, IDictionary<String,String>, Sku, String, String, String, String, Nullable<Int64>, String, String, String, String, Nullable<Guid>, Nullable<DateTime>, String, String, String, String, Nullable<DateTime>, Nullable<DateTime>, String, String, String, String, String, Nullable<Boolean>, String, Nullable<Int64>, Nullable<DateTime>, String, Nullable<Int32>, Sku, Nullable<Int32>, Nullable<Double>, Nullable<DateTime>, Nullable<DateTime>)

Initializes a new instance of the Database class.

Declaration
public Database (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 managedBy = null, string createMode = null, string collation = null, Nullable<long> maxSizeBytes = null, string sampleName = null, string elasticPoolId = null, string sourceDatabaseId = null, string status = null, Nullable<Guid> databaseId = null, Nullable<DateTime> creationDate = null, string currentServiceObjectiveName = null, string requestedServiceObjectiveName = null, string defaultSecondaryLocation = null, string failoverGroupId = null, Nullable<DateTime> restorePointInTime = null, Nullable<DateTime> sourceDatabaseDeletionDate = null, string recoveryServicesRecoveryPointId = null, string longTermRetentionBackupResourceId = null, string recoverableDatabaseId = null, string restorableDroppedDatabaseId = null, string catalogCollation = null, Nullable<bool> zoneRedundant = null, string licenseType = null, Nullable<long> maxLogSizeBytes = null, Nullable<DateTime> earliestRestoreDate = null, string readScale = null, Nullable<int> readReplicaCount = null, Microsoft.Azure.Management.Sql.Models.Sku currentSku = null, Nullable<int> autoPauseDelay = null, Nullable<double> minCapacity = null, Nullable<DateTime> pausedDate = null, Nullable<DateTime> resumedDate = 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 database 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 one of
         the following commands:
        
         ```azurecli
         az sql db list-editions -l &lt;location&gt; -o table
         ````
        
         ```powershell
         Get-AzSqlServerServiceObjective -Location &lt;location&gt;
         ````

String kind

Kind of database. This is metadata used for the Azure portal experience.
String managedBy

Resource that manages the database.
String createMode

Specifies the mode of database creation.

         Default: regular database creation.
        
         Copy: creates a database as a copy of an existing database.
         sourceDatabaseId must be specified as the resource ID of the source
         database.
        
         Secondary: creates a database as a secondary replica of an existing
         database. sourceDatabaseId must be specified as the resource ID of
         the existing primary database.
        
         PointInTimeRestore: Creates a database by restoring a point in time
         backup of an existing database. sourceDatabaseId must be specified
         as the resource ID of the existing database, and restorePointInTime
         must be specified.
        
         Recovery: Creates a database by restoring a geo-replicated backup.
         sourceDatabaseId must be specified as the recoverable database
         resource ID to restore.
        
         Restore: Creates a database by restoring a backup of a deleted
         database. sourceDatabaseId must be specified. If sourceDatabaseId
         is the database's original resource ID, then
         sourceDatabaseDeletionDate must be specified. Otherwise
         sourceDatabaseId must be the restorable dropped database resource
         ID and sourceDatabaseDeletionDate is ignored. restorePointInTime
         may also be specified to restore from an earlier point in time.
        
         RestoreLongTermRetentionBackup: Creates a database by restoring
         from a long term retention vault.
         recoveryServicesRecoveryPointResourceId must be specified as the
         recovery point resource ID.
        
         Copy, Secondary, and RestoreLongTermRetentionBackup are not
         supported for DataWarehouse edition. Possible values include:
         'Default', 'Copy', 'Secondary', 'PointInTimeRestore', 'Restore',
         'Recovery', 'RestoreExternalBackup',
         'RestoreExternalBackupSecondary', 'RestoreLongTermRetentionBackup',
         'OnlineSecondary'

String collation

The collation of the database.
Nullable<Int64> maxSizeBytes

The max size of the database expressed in bytes.
String sampleName

The name of the sample schema to apply when creating this database. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'
String elasticPoolId

The resource identifier of the elastic pool containing this database.
String sourceDatabaseId

The resource identifier of the source database associated with create operation of this database.
String status

The status of the database. Possible values include: 'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect', 'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed', 'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing', 'Paused', 'Resuming', 'Scaling', 'OfflineChangingDwPerformanceTiers', 'OnlineChangingDwPerformanceTiers', 'Disabled'
Nullable<Guid> databaseId

The ID of the database.
Nullable<DateTime> creationDate

The creation date of the database (ISO8601 format).
String currentServiceObjectiveName

The current service level objective name of the database.
String requestedServiceObjectiveName

The requested service level objective name of the database.
String defaultSecondaryLocation

The default secondary region for this database.
String failoverGroupId

Failover Group resource identifier that this database belongs to.
Nullable<DateTime> restorePointInTime

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
Nullable<DateTime> sourceDatabaseDeletionDate

Specifies the time that the database was deleted.
String recoveryServicesRecoveryPointId

The resource identifier of the recovery point associated with create operation of this database.
String longTermRetentionBackupResourceId

The resource identifier of the long term retention backup associated with create operation of this database.
String recoverableDatabaseId

The resource identifier of the recoverable database associated with create operation of this database.
String restorableDroppedDatabaseId

The resource identifier of the restorable dropped database associated with create operation of this database.
String catalogCollation

Collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'
Nullable<Boolean> zoneRedundant

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
String licenseType

The license type to apply for this database. Possible values include: 'LicenseIncluded', 'BasePrice'
Nullable<Int64> maxLogSizeBytes

The max log size for this database.
Nullable<DateTime> earliestRestoreDate

This records the earliest start date and time that restore is available for this database (ISO8601 format).
String readScale

If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. Possible values include: 'Enabled', 'Disabled'
Nullable<Int32> readReplicaCount

The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
Sku currentSku

The name and tier of the SKU.
Nullable<Int32> autoPauseDelay

Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
Nullable<Double> minCapacity

Minimal capacity that database will always have allocated, if not paused
Nullable<DateTime> pausedDate

The date when database was paused by user configuration or action (ISO8601 format). Null if the database is ready.
Nullable<DateTime> resumedDate

The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

Properties

AutoPauseDelay

Gets or sets time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.autoPauseDelay")]
public Nullable<int> AutoPauseDelay { get; set; }
Property Value
Nullable<Int32>

CatalogCollation

Gets or sets collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'

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

Collation

Gets or sets the collation of the database.

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

CreateMode

Gets or sets specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: 'Default', 'Copy', 'Secondary', 'PointInTimeRestore', 'Restore', 'Recovery', 'RestoreExternalBackup', 'RestoreExternalBackupSecondary', 'RestoreLongTermRetentionBackup', 'OnlineSecondary'

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

CreationDate

Gets the creation date of the database (ISO8601 format).

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

CurrentServiceObjectiveName

Gets the current service level objective name of the database.

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

CurrentSku

Gets the name and tier of the SKU.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.currentSku")]
public Microsoft.Azure.Management.Sql.Models.Sku CurrentSku { get; }
Property Value
Sku

DatabaseId

Gets the ID of the database.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.databaseId")]
public Nullable<Guid> DatabaseId { get; }
Property Value
Nullable<Guid>

DefaultSecondaryLocation

Gets the default secondary region for this database.

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

EarliestRestoreDate

Gets this records the earliest start date and time that restore is available for this database (ISO8601 format).

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

Edition

Gets the edition of the database. If createMode is OnlineSecondary, this value is ignored.To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: "Capabilities_ListByLocation." or use the Azure CLI command az sql db list-editions -l westus --query[].name. Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2'

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

ElasticPoolId

Gets or sets the resource identifier of the elastic pool containing this database.

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

ElasticPoolName

Gets the name of the elastic pool the database is in. If elasticPoolName and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveName is ignored. Not supported for DataWarehouse edition.

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

FailoverGroupId

Gets failover Group resource identifier that this database belongs to.

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

Kind

Gets kind of database. 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 database. Possible values include: 'LicenseIncluded', 'BasePrice'

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

LongTermRetentionBackupResourceId

Gets or sets the resource identifier of the long term retention backup associated with create operation of this database.

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

ManagedBy

Gets resource that manages the database.

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

MaxLogSizeBytes

Gets the max log size for this database.

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

MaxSizeBytes

Gets or sets the max size of the database expressed in bytes.

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

MinCapacity

Gets or sets minimal capacity that database will always have allocated, if not paused

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.minCapacity")]
public Nullable<double> MinCapacity { get; set; }
Property Value
Nullable<Double>

PausedDate

Gets the date when database was paused by user configuration or action (ISO8601 format). Null if the database is ready.

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

ReadReplicaCount

Gets or sets the number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.readReplicaCount")]
public Nullable<int> ReadReplicaCount { get; set; }
Property Value
Nullable<Int32>

ReadScale

Gets or sets if enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. Possible values include: 'Enabled', 'Disabled'

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

RecoverableDatabaseId

Gets or sets the resource identifier of the recoverable database associated with create operation of this database.

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

RecoveryServicesRecoveryPointId

Gets or sets the resource identifier of the recovery point associated with create operation of this database.

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

RequestedServiceObjectiveName

Gets the requested service level objective name of the database.

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

RestorableDroppedDatabaseId

Gets or sets the resource identifier of the restorable dropped database associated with create operation of this database.

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

RestorePointInTime

Gets or sets specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

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

ResumedDate

Gets the date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

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

SampleName

Gets or sets the name of the sample schema to apply when creating this database. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'

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

ServiceLevelObjective

Gets the current service level objective of the database.

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

Sku

Gets or sets the database 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 one of the following commands:

az sql db list-editions -l &amp;lt;location&amp;gt; -o table

Get-AzSqlServerServiceObjective -Location &amp;lt;location&amp;gt;
Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="sku")]
public Microsoft.Azure.Management.Sql.Models.Sku Sku { get; set; }
Property Value
Sku

SourceDatabaseDeletionDate

Gets or sets specifies the time that the database was deleted.

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

SourceDatabaseId

Gets or sets the resource identifier of the source database associated with create operation of this database.

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

Status

Gets the status of the database. Possible values include: 'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect', 'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed', 'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing', 'Paused', 'Resuming', 'Scaling', 'OfflineChangingDwPerformanceTiers', 'OnlineChangingDwPerformanceTiers', 'Disabled'

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

ZoneRedundant

Gets or sets whether or not this database is zone redundant, which means the replicas of this database 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