DatabaseInner Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
DatabaseInner()
Initializes a new instance of the DatabaseInner class.
public DatabaseInner ();
Public Sub New ()
Applies to
DatabaseInner(String, String, String, String, IDictionary<String, String>, String, String, Nullable<DateTime>, Nullable<Int64>, Nullable<Guid>, Nullable<Guid>, Nullable<DateTime>, CreateMode, String, Nullable<DateTime>, Nullable<DateTime>, String, DatabaseEdition, String, Nullable<Guid>, ServiceObjectiveName, ServiceObjectiveName, String, String, String, IList<ServiceTierAdvisorInner>, IList<TransparentDataEncryptionInner>, IList<RecommendedIndex>, String, Nullable<ReadScale>, SampleName, Nullable<Boolean>)
Initializes a new instance of the DatabaseInner class.
public DatabaseInner (string location, string id = default, string name = default, string type = default, System.Collections.Generic.IDictionary<string,string> tags = default, string kind = default, string collation = default, DateTime? creationDate = default, long? containmentState = default, Guid? currentServiceObjectiveId = default, Guid? databaseId = default, DateTime? earliestRestoreDate = default, Microsoft.Azure.Management.Sql.Fluent.Models.CreateMode createMode = default, string sourceDatabaseId = default, DateTime? sourceDatabaseDeletionDate = default, DateTime? restorePointInTime = default, string recoveryServicesRecoveryPointResourceId = default, Microsoft.Azure.Management.Sql.Fluent.Models.DatabaseEdition edition = default, string maxSizeBytes = default, Guid? requestedServiceObjectiveId = default, Microsoft.Azure.Management.Sql.Fluent.Models.ServiceObjectiveName requestedServiceObjectiveName = default, Microsoft.Azure.Management.Sql.Fluent.Models.ServiceObjectiveName serviceLevelObjective = default, string status = default, string elasticPoolName = default, string defaultSecondaryLocation = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Fluent.Models.ServiceTierAdvisorInner> serviceTierAdvisors = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Fluent.Models.TransparentDataEncryptionInner> transparentDataEncryption = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Fluent.Models.RecommendedIndex> recommendedIndex = default, string failoverGroupId = default, Microsoft.Azure.Management.Sql.Fluent.Models.ReadScale? readScale = default, Microsoft.Azure.Management.Sql.Fluent.Models.SampleName sampleName = default, bool? zoneRedundant = default);
new Microsoft.Azure.Management.Sql.Fluent.Models.DatabaseInner : string * string * string * string * System.Collections.Generic.IDictionary<string, string> * string * string * Nullable<DateTime> * Nullable<int64> * Nullable<Guid> * Nullable<Guid> * Nullable<DateTime> * Microsoft.Azure.Management.Sql.Fluent.Models.CreateMode * string * Nullable<DateTime> * Nullable<DateTime> * string * Microsoft.Azure.Management.Sql.Fluent.Models.DatabaseEdition * string * Nullable<Guid> * Microsoft.Azure.Management.Sql.Fluent.Models.ServiceObjectiveName * Microsoft.Azure.Management.Sql.Fluent.Models.ServiceObjectiveName * string * string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Fluent.Models.ServiceTierAdvisorInner> * System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Fluent.Models.TransparentDataEncryptionInner> * System.Collections.Generic.IList<Microsoft.Azure.Management.Sql.Fluent.Models.RecommendedIndex> * string * Nullable<Microsoft.Azure.Management.Sql.Fluent.Models.ReadScale> * Microsoft.Azure.Management.Sql.Fluent.Models.SampleName * Nullable<bool> -> Microsoft.Azure.Management.Sql.Fluent.Models.DatabaseInner
Public Sub New (location As String, Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional kind As String = Nothing, Optional collation As String = Nothing, Optional creationDate As Nullable(Of DateTime) = Nothing, Optional containmentState As Nullable(Of Long) = Nothing, Optional currentServiceObjectiveId As Nullable(Of Guid) = Nothing, Optional databaseId As Nullable(Of Guid) = Nothing, Optional earliestRestoreDate As Nullable(Of DateTime) = Nothing, Optional createMode As CreateMode = Nothing, Optional sourceDatabaseId As String = Nothing, Optional sourceDatabaseDeletionDate As Nullable(Of DateTime) = Nothing, Optional restorePointInTime As Nullable(Of DateTime) = Nothing, Optional recoveryServicesRecoveryPointResourceId As String = Nothing, Optional edition As DatabaseEdition = Nothing, Optional maxSizeBytes As String = Nothing, Optional requestedServiceObjectiveId As Nullable(Of Guid) = Nothing, Optional requestedServiceObjectiveName As ServiceObjectiveName = Nothing, Optional serviceLevelObjective As ServiceObjectiveName = Nothing, Optional status As String = Nothing, Optional elasticPoolName As String = Nothing, Optional defaultSecondaryLocation As String = Nothing, Optional serviceTierAdvisors As IList(Of ServiceTierAdvisorInner) = Nothing, Optional transparentDataEncryption As IList(Of TransparentDataEncryptionInner) = Nothing, Optional recommendedIndex As IList(Of RecommendedIndex) = Nothing, Optional failoverGroupId As String = Nothing, Optional readScale As Nullable(Of ReadScale) = Nothing, Optional sampleName As SampleName = Nothing, Optional zoneRedundant As Nullable(Of Boolean) = Nothing)
Parameters
- location
- String
Resource location.
- id
- String
- name
- String
- type
- String
- tags
- IDictionary<String,String>
Resource tags.
- kind
- String
Kind of database. This is metadata used for the Azure portal experience.
- collation
- String
The collation of the database. If createMode is not Default, this value is ignored.
The current service level objective ID of the database. This is the ID of the service level objective that is currently active.
This records the earliest start date and time that restore is available for this database (ISO8601 format).
- createMode
- 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.
OnlineSecondary/NonReadableSecondary: creates a database as a
(readable or nonreadable) 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, NonReadableSecondary, OnlineSecondary and
RestoreLongTermRetentionBackup are not supported for DataWarehouse
edition. Possible values include: 'Copy', 'Default',
'NonReadableSecondary', 'OnlineSecondary', 'PointInTimeRestore',
'Recovery', 'Restore', 'RestoreLongTermRetentionBackup'
- sourceDatabaseId
- String
Conditional. If createMode is Copy, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, Recovery, or Restore, then this value is required. Specifies the resource ID of the source database. If createMode is NonReadableSecondary or OnlineSecondary, the name of the source database must be the same as the new database being created.
Conditional. If createMode is Restore and sourceDatabaseId is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.
Conditional. If createMode is PointInTimeRestore, this value is required. If createMode is Restore, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.
- recoveryServicesRecoveryPointResourceId
- String
Conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.
- edition
- DatabaseEdition
The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.
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 <location> -o table
````
```powershell
Get-AzSqlServerServiceObjective -Location <location>
````
. Possible values include: 'Web', 'Business', 'Basic', 'Standard',
'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse',
'System', 'System2', 'GeneralPurpose', 'BusinessCritical',
'Hyperscale'
- maxSizeBytes
- String
The max size of the database expressed in bytes. If createMode is not Default, 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."
The configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName.
The list of SKUs may vary by region and support offer. To determine
the service objective ids that are available to your subscription
in an Azure region, use the `Capabilities_ListByLocation` REST
API.
- requestedServiceObjectiveName
- ServiceObjectiveName
The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property.
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 <location> -o table
````
```powershell
Get-AzSqlServerServiceObjective -Location <location>
````
. Possible values include: 'System', 'System0', 'System1',
'System2', 'System3', 'System4', 'System2L', 'System3L',
'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6',
'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15',
'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400',
'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500',
'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c',
'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c',
'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600',
'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'
- serviceLevelObjective
- ServiceObjectiveName
The current service level objective of the database. Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'
- status
- String
The status of the database.
- elasticPoolName
- String
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.
- defaultSecondaryLocation
- String
The default secondary region for this database.
- serviceTierAdvisors
- IList<ServiceTierAdvisorInner>
The list of service tier advisors for this database. Expanded property
- transparentDataEncryption
- IList<TransparentDataEncryptionInner>
The transparent data encryption info for this database.
- recommendedIndex
- IList<RecommendedIndex>
The recommended indices for this database.
- failoverGroupId
- String
The resource identifier of the failover group containing this database.
Conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition. Possible values include: 'Enabled', 'Disabled'
- sampleName
- SampleName
Indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition. Possible values include: 'AdventureWorksLT'
Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.