Udostępnij za pośrednictwem


DatabaseInner Class

Definition

Represents a database.

[Microsoft.Rest.Serialization.JsonTransformation]
public class DatabaseInner : Microsoft.Azure.Management.Sql.Fluent.Models.TrackedResourceInner
[<Microsoft.Rest.Serialization.JsonTransformation>]
type DatabaseInner = class
    inherit TrackedResourceInner
Public Class DatabaseInner
Inherits TrackedResourceInner
Inheritance
Attributes

Constructors

DatabaseInner()

Initializes a new instance of the DatabaseInner class.

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.

Properties

Collation

Gets or sets the collation of the database. If createMode is not Default, this value is ignored.

ContainmentState

Gets the containment state of the database.

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.

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'

CreationDate

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

CurrentServiceObjectiveId

Gets the current service level objective ID of the database. This is the ID of the service level objective that is currently active.

DatabaseId

Gets the ID of the database.

DefaultSecondaryLocation

Gets the default secondary region for this database.

EarliestRestoreDate

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

Edition

Gets or sets 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:

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

. Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'

ElasticPoolName

Gets or sets 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.

FailoverGroupId

Gets the resource identifier of the failover group containing this database.

Id

Resource Id. Setter is protected because Id needs to be set in Network resources.

(Inherited from ProxyResource)
Kind

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

Location

Resource location

(Inherited from Resource)
MaxSizeBytes

Gets or sets 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."

Name

Resource name

(Inherited from ProxyResource)
ReadScale

Gets or sets 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'

RecommendedIndex

Gets the recommended indices for this database.

RecoveryServicesRecoveryPointResourceId

Gets or sets conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.

RequestedServiceObjectiveId

Gets or sets 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

Gets or sets 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:

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

. 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'

RestorePointInTime

Gets or sets 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.

SampleName

Gets or sets 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'

ServiceLevelObjective

Gets 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'

ServiceTierAdvisors

Gets the list of service tier advisors for this database. Expanded property

SourceDatabaseDeletionDate

Gets or sets 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.

SourceDatabaseId

Gets or sets 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.

Status

Gets the status of the database.

Tags

Resource tags

(Inherited from Resource)
TransparentDataEncryption

Gets the transparent data encryption info for this database.

Type

Resource type

(Inherited from ProxyResource)
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.

Methods

Validate()

Validate the object.

Applies to