Database Class

Reference

Definition

Namespace:: Microsoft.Azure.Management.Sql.Models

Assembly:: Microsoft.Azure.Management.Sql.dll

Package:: Microsoft.Azure.Management.Sql v3.1.0-preview

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.

A database resource.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Database : Microsoft.Azure.Management.Sql.Models.TrackedResource

[<Microsoft.Rest.Serialization.JsonTransformation>]
type Database = class
    inherit TrackedResource

Public Class Database
Inherits TrackedResource

Inheritance: Object

Resource

TrackedResource
Database

Attributes: JsonTransformationAttribute

Constructors

Database()

Initializes a new instance of the Database class.

Database(String, String, String, String, IDictionary<String,String>, Sku, String, String, DatabaseIdentity, 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>, String, Sku, Nullable<Int32>, String, String, Nullable<Double>, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Guid>, String)

Initializes a new instance of the Database class.

Properties

AutoPauseDelay	Gets or sets time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
CatalogCollation	Gets or sets collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'
Collation	Gets or sets the collation 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. 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'
CreationDate	Gets the creation date of the database (ISO8601 format).
CurrentBackupStorageRedundancy	Gets the storage account type used to store backups for this database. Possible values include: 'Geo', 'Local', 'Zone', 'GeoZone'
CurrentServiceObjectiveName	Gets the current service level objective name of the database.
CurrentSku	Gets the name and tier of the SKU.
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 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'
ElasticPoolId	Gets or sets the resource identifier of the elastic pool containing this database.
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.
FailoverGroupId	Gets failover Group resource identifier that this database belongs to.
FederatedClientId	Gets or sets the Client id used for cross tenant per database CMK scenario
HighAvailabilityReplicaCount	Gets or sets the number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
Id	Gets resource ID. (Inherited from Resource)
Identity	Gets or sets the Azure Active Directory identity of the database.
IsInfraEncryptionEnabled	Gets infra encryption is enabled for this database.
IsLedgerOn	Gets or sets whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
Kind	Gets kind of database. This is metadata used for the Azure portal experience.
LicenseType	Gets or sets the license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. Possible values include: 'LicenseIncluded', 'BasePrice'
Location	Gets or sets resource location. (Inherited from TrackedResource)
LongTermRetentionBackupResourceId	Gets or sets the resource identifier of the long term retention backup associated with create operation of this database.
MaintenanceConfigurationId	Gets or sets maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
ManagedBy	Gets resource that manages the database.
MaxLogSizeBytes	Gets the max log size for this database.
MaxSizeBytes	Gets or sets the max size of the database expressed in bytes.
MinCapacity	Gets or sets minimal capacity that database will always have allocated, if not paused
Name	Gets resource name. (Inherited from Resource)
PausedDate	Gets the date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
ReadScale	Gets or sets the state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. Possible values include: 'Enabled', 'Disabled'
RecoverableDatabaseId	Gets or sets the resource identifier of the recoverable database associated with create operation of this database.
RecoveryServicesRecoveryPointId	Gets or sets the resource identifier of the recovery point associated with create operation of this database.
RequestedBackupStorageRedundancy	Gets or sets the storage account type to be used to store backups for this database. Possible values include: 'Geo', 'Local', 'Zone', 'GeoZone'
RequestedServiceObjectiveName	Gets the requested service level objective name of the database.
RestorableDroppedDatabaseId	Gets or sets the resource identifier of the restorable dropped database associated with create operation of this database.
RestorePointInTime	Gets or sets specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
ResumedDate	Gets the date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
SampleName	Gets or sets the name of the sample schema to apply when creating this database. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'
SecondaryType	Gets or sets the secondary type of the database if it is a secondary. Valid values are Geo and Named. Possible values include: 'Geo', 'Named'
ServiceLevelObjective	Gets the current service level objective of the database.
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 &lt;location&gt; -o table` `Get-AzSqlServerServiceObjective -Location &lt;location&gt;`
SourceDatabaseDeletionDate	Gets or sets specifies the time that the database was deleted.
SourceDatabaseId	Gets or sets the resource identifier of the source database associated with create operation of this database.
SourceResourceId	Gets or sets the resource identifier of the source associated with the create operation of this database. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of an existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. This property allows to restore across subscriptions which is only supported for DataWarehouse edition. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
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', 'Stopping', 'Stopped', 'Starting'
Tags	Gets or sets resource tags. (Inherited from TrackedResource)
Type	Gets resource type. (Inherited from Resource)
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

Dela via