class Azure::SQL::Mgmt::V2017_10_01_preview::Models::Database
A database resource.
Attributes
@return [Integer] Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
@return [CatalogCollationType] Collation of the metadata catalog. Possible values include: 'DATABASE_DEFAULT', 'SQL_Latin1_General_CP1_CI_AS'
@return [String] The collation of the database.
@return [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'
@return [DateTime] The creation date of the database (ISO8601 format).
@return [String] The current service level objective name of the database.
@return [Sku] The name and tier of the SKU.
@return The ID of the database.
@return [String] The default secondary region for this database.
@return [DateTime] This records the earliest start date and time that restore is available for this database (ISO8601 format).
@return [String] The resource identifier of the elastic pool containing this database.
@return [String] Failover Group resource identifier that this database belongs to.
@return [String] Kind of database. This is metadata used for the Azure
portal experience.
@return [DatabaseLicenseType] The license type to apply for this database. Possible values include: 'LicenseIncluded', 'BasePrice'
@return [String] The resource identifier of the long term retention backup associated with create operation of this database.
@return [String] Resource
that manages the database.
@return [Integer] The max log size for this database.
@return [Integer] The max size of the database expressed in bytes.
@return [Float] Minimal capacity that database will always have allocated, if not paused
@return [DateTime] The date when database was paused by user configuration or action (ISO8601 format). Null if the database is ready.
@return [Integer] 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.
@return [DatabaseReadScale] 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'
@return [String] The resource identifier of the recoverable database associated with create operation of this database.
@return [String] The resource identifier of the recovery point associated with create operation of this database.
@return [String] The requested service level objective name of the database.
@return [String] The resource identifier of the restorable dropped database associated with create operation of this database.
@return [DateTime] Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
@return [DateTime] The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
@return [SampleName] The name of the sample schema to apply when creating this database. Possible values include: 'AdventureWorksLT', 'WideWorldImportersStd', 'WideWorldImportersFull'
@return [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 <location> -o table ““
“`powershell Get-AzSqlServerServiceObjective -Location <location> ““
@return [DateTime] Specifies the time that the database was deleted.
@return [String] The resource identifier of the source database associated with create operation of this database.
@return [DatabaseStatus] 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'
@return [Boolean] Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
Private Class Methods
Mapper for Database
class as Ruby Hash. This will be used for serialization/deserialization.
# File lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb, line 211 def self.mapper() { client_side_validation: true, required: false, serialized_name: 'Database', type: { name: 'Composite', class_name: 'Database', model_properties: { id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'id', type: { name: 'String' } }, name: { client_side_validation: true, required: false, read_only: true, serialized_name: 'name', type: { name: 'String' } }, type: { client_side_validation: true, required: false, read_only: true, serialized_name: 'type', type: { name: 'String' } }, location: { client_side_validation: true, required: true, serialized_name: 'location', type: { name: 'String' } }, tags: { client_side_validation: true, required: false, serialized_name: 'tags', type: { name: 'Dictionary', value: { client_side_validation: true, required: false, serialized_name: 'StringElementType', type: { name: 'String' } } } }, sku: { client_side_validation: true, required: false, serialized_name: 'sku', type: { name: 'Composite', class_name: 'Sku' } }, kind: { client_side_validation: true, required: false, read_only: true, serialized_name: 'kind', type: { name: 'String' } }, managed_by: { client_side_validation: true, required: false, read_only: true, serialized_name: 'managedBy', type: { name: 'String' } }, create_mode: { client_side_validation: true, required: false, serialized_name: 'properties.createMode', type: { name: 'String' } }, collation: { client_side_validation: true, required: false, serialized_name: 'properties.collation', type: { name: 'String' } }, max_size_bytes: { client_side_validation: true, required: false, serialized_name: 'properties.maxSizeBytes', type: { name: 'Number' } }, sample_name: { client_side_validation: true, required: false, serialized_name: 'properties.sampleName', type: { name: 'String' } }, elastic_pool_id: { client_side_validation: true, required: false, serialized_name: 'properties.elasticPoolId', type: { name: 'String' } }, source_database_id: { client_side_validation: true, required: false, serialized_name: 'properties.sourceDatabaseId', type: { name: 'String' } }, status: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.status', type: { name: 'String' } }, database_id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.databaseId', type: { name: 'String' } }, creation_date: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.creationDate', type: { name: 'DateTime' } }, current_service_objective_name: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.currentServiceObjectiveName', type: { name: 'String' } }, requested_service_objective_name: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.requestedServiceObjectiveName', type: { name: 'String' } }, default_secondary_location: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.defaultSecondaryLocation', type: { name: 'String' } }, failover_group_id: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.failoverGroupId', type: { name: 'String' } }, restore_point_in_time: { client_side_validation: true, required: false, serialized_name: 'properties.restorePointInTime', type: { name: 'DateTime' } }, source_database_deletion_date: { client_side_validation: true, required: false, serialized_name: 'properties.sourceDatabaseDeletionDate', type: { name: 'DateTime' } }, recovery_services_recovery_point_id: { client_side_validation: true, required: false, serialized_name: 'properties.recoveryServicesRecoveryPointId', type: { name: 'String' } }, long_term_retention_backup_resource_id: { client_side_validation: true, required: false, serialized_name: 'properties.longTermRetentionBackupResourceId', type: { name: 'String' } }, recoverable_database_id: { client_side_validation: true, required: false, serialized_name: 'properties.recoverableDatabaseId', type: { name: 'String' } }, restorable_dropped_database_id: { client_side_validation: true, required: false, serialized_name: 'properties.restorableDroppedDatabaseId', type: { name: 'String' } }, catalog_collation: { client_side_validation: true, required: false, serialized_name: 'properties.catalogCollation', type: { name: 'String' } }, zone_redundant: { client_side_validation: true, required: false, serialized_name: 'properties.zoneRedundant', type: { name: 'Boolean' } }, license_type: { client_side_validation: true, required: false, serialized_name: 'properties.licenseType', type: { name: 'String' } }, max_log_size_bytes: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.maxLogSizeBytes', type: { name: 'Number' } }, earliest_restore_date: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.earliestRestoreDate', type: { name: 'DateTime' } }, read_scale: { client_side_validation: true, required: false, serialized_name: 'properties.readScale', type: { name: 'String' } }, read_replica_count: { client_side_validation: true, required: false, serialized_name: 'properties.readReplicaCount', type: { name: 'Number' } }, current_sku: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.currentSku', type: { name: 'Composite', class_name: 'Sku' } }, auto_pause_delay: { client_side_validation: true, required: false, serialized_name: 'properties.autoPauseDelay', type: { name: 'Number' } }, min_capacity: { client_side_validation: true, required: false, serialized_name: 'properties.minCapacity', type: { name: 'Double' } }, paused_date: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.pausedDate', type: { name: 'DateTime' } }, resumed_date: { client_side_validation: true, required: false, read_only: true, serialized_name: 'properties.resumedDate', type: { name: 'DateTime' } } } } } end