SQL Server Database

This table represents the SQL Server Database resource from Microsoft Azure.

azure.sql_server_database

Fields

TitleIDTypeData TypeDescription
_keycorestring
auto_pause_delaycoreint64Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
catalog_collationcorestringCollation of the metadata catalog.
collationcorestringThe collation of the database.
create_modecorestringSpecifies 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.
creation_datecorestringThe creation date of the database (ISO8601 format).
current_service_objective_namecorestringThe current service level objective name of the database.
current_skucorejsonThe name and tier of the SKU.
database_idcorestringThe ID of the database.
default_secondary_locationcorestringThe default secondary region for this database.
earliest_restore_datecorestringThis records the earliest start date and time that restore is available for this database (ISO8601 format).
elastic_pool_idcorestringThe resource identifier of the elastic pool containing this database.
failover_group_idcorestringFailover Group resource identifier that this database belongs to.
high_availability_replica_countcoreint64The number of secondary replicas associated with the database that are used to provide high availability.
idcorestringResource ID.
kindcorestringKind of database. This is metadata used for the Azure portal experience.
license_typecorestringThe 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.
locationcorestringResource location.
long_term_retention_backup_resource_idcorestringThe resource identifier of the long term retention backup associated with create operation of this database.
maintenance_configuration_idcorestringMaintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
managed_bycorestringResource that manages the database.
max_log_size_bytescoreint64The max log size for this database.
max_size_bytescoreint64The max size of the database expressed in bytes.
min_capacitycorefloat64Minimal capacity that database will always have allocated, if not paused
namecorestringResource name.
paused_datecorestringThe date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
read_scalecorestringThe 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.
recoverable_database_idcorestringThe resource identifier of the recoverable database associated with create operation of this database.
recovery_services_recovery_point_idcorestringThe resource identifier of the recovery point associated with create operation of this database.
requested_service_objective_namecorestringThe requested service level objective name of the database.
resource_groupcorestring
restorable_dropped_database_idcorestringThe resource identifier of the restorable dropped database associated with create operation of this database.
restore_point_in_timecorestringSpecifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
resumed_datecorestringThe date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
sample_namecorestringThe name of the sample schema to apply when creating this database.
secondary_typecorestringThe secondary type of the database if it is a secondary. Valid values are Geo and Named.
skucorejsonThe 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:```azurecliaz sql db list-editions -l <location> -o table```````powershellGet-AzSqlServerServiceObjective -Location <location>````
source_database_deletion_datecorestringSpecifies the time that the database was deleted.
source_database_idcorestringThe resource identifier of the source database associated with create operation of this database.
statuscorestringThe status of the database.
storage_account_typecorestringThe storage account type used to store backups for this database.
subscription_idcorestring
subscription_namecorestring
tagscorehstore
transparent_data_encryptioncorejson
typecorestringResource type.
zone_redundantcoreboolWhether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.