azure_sql_server_database
auto_pause_delay
Type: INT64
Provider name: properties.autoPauseDelay
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
catalog_collation
Type: STRING
Provider name: properties.catalogCollation
Description: Collation of the metadata catalog.
collation
Type: STRING
Provider name: properties.collation
Description: The collation of the database.
create_mode
Type: STRING
Provider name: properties.createMode
Description: 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.
creation_date
Type: STRING
Provider name: properties.creationDate
Description: The creation date of the database (ISO8601 format).
current_service_objective_name
Type: STRING
Provider name: properties.currentServiceObjectiveName
Description: The current service level objective name of the database.
current_sku
Type: STRUCT
Provider name: properties.currentSku
Description: The name and tier of the SKU.
capacity
Type: INT32
Provider name: capacity
Description: Capacity of the particular SKU.
family
Type: STRING
Provider name: family
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here.
name
Type: STRING
Provider name: name
Description: The name of the SKU, typically, a letter + Number code, e.g. P3.
size
Type: STRING
Provider name: size
Description: Size of the particular SKU
tier
Type: STRING
Provider name: tier
Description: The tier or edition of the particular SKU, e.g. Basic, Premium.
database_id
Type: STRING
Provider name: properties.databaseId
Description: The ID of the database.
default_secondary_location
Type: STRING
Provider name: properties.defaultSecondaryLocation
Description: The default secondary region for this database.
earliest_restore_date
Type: STRING
Provider name: properties.earliestRestoreDate
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format).
elastic_pool_id
Type: STRING
Provider name: properties.elasticPoolId
Description: The resource identifier of the elastic pool containing this database.
failover_group_id
Type: STRING
Provider name: properties.failoverGroupId
Description: Failover Group resource identifier that this database belongs to.
high_availability_replica_count
Type: INT32
Provider name: properties.highAvailabilityReplicaCount
Description: The number of secondary replicas associated with the database that are used to provide high availability.
id
Type: STRING
Provider name: id
Description: Resource ID.
kind
Type: STRING
Provider name: kind
Description: Kind of database. This is metadata used for the Azure portal experience.
license_type
Type: STRING
Provider name: properties.licenseType
Description: 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.
location
Type: STRING
Provider name: location
Description: Resource location.
long_term_retention_backup_resource_id
Type: STRING
Provider name: properties.longTermRetentionBackupResourceId
Description: The resource identifier of the long term retention backup associated with create operation of this database.
maintenance_configuration_id
Type: STRING
Provider name: properties.maintenanceConfigurationId
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
managed_by
Type: STRING
Provider name: managedBy
Description: Resource that manages the database.
max_log_size_bytes
Type: INT64
Provider name: properties.maxLogSizeBytes
Description: The max log size for this database.
max_size_bytes
Type: INT64
Provider name: properties.maxSizeBytes
Description: The max size of the database expressed in bytes.
min_capacity
Type: DOUBLE
Provider name: properties.minCapacity
Description: Minimal capacity that database will always have allocated, if not paused
name
Type: STRING
Provider name: name
Description: Resource name.
paused_date
Type: STRING
Provider name: properties.pausedDate
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.
read_scale
Type: STRING
Provider name: properties.readScale
Description: 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.
recoverable_database_id
Type: STRING
Provider name: properties.recoverableDatabaseId
Description: The resource identifier of the recoverable database associated with create operation of this database.
recovery_services_recovery_point_id
Type: STRING
Provider name: properties.recoveryServicesRecoveryPointId
Description: The resource identifier of the recovery point associated with create operation of this database.
requested_service_objective_name
Type: STRING
Provider name: properties.requestedServiceObjectiveName
Description: The requested service level objective name of the database.
resource_group
Type: STRING
restorable_dropped_database_id
Type: STRING
Provider name: properties.restorableDroppedDatabaseId
Description: The resource identifier of the restorable dropped database associated with create operation of this database.
restore_point_in_time
Type: STRING
Provider name: properties.restorePointInTime
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
resumed_date
Type: STRING
Provider name: properties.resumedDate
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.
sample_name
Type: STRING
Provider name: properties.sampleName
Description: The name of the sample schema to apply when creating this database.
secondary_type
Type: STRING
Provider name: properties.secondaryType
Description: The secondary type of the database if it is a secondary. Valid values are Geo and Named.
sku
Type: STRUCT
Provider name: sku
Description: 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:```azurecliaz sql db list-editions -l -o table```````powershellGet-AzSqlServerServiceObjective -Location ````
capacity
Type: INT32
Provider name: capacity
Description: Capacity of the particular SKU.
family
Type: STRING
Provider name: family
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here.
name
Type: STRING
Provider name: name
Description: The name of the SKU, typically, a letter + Number code, e.g. P3.
size
Type: STRING
Provider name: size
Description: Size of the particular SKU
tier
Type: STRING
Provider name: tier
Description: The tier or edition of the particular SKU, e.g. Basic, Premium.
source_database_deletion_date
Type: STRING
Provider name: properties.sourceDatabaseDeletionDate
Description: Specifies the time that the database was deleted.
source_database_id
Type: STRING
Provider name: properties.sourceDatabaseId
Description: The resource identifier of the source database associated with create operation of this database.
status
Type: STRING
Provider name: properties.status
Description: The status of the database.
storage_account_type
Type: STRING
Provider name: properties.storageAccountType
Description: The storage account type used to store backups for this database.
subscription_id
Type: STRING
subscription_name
Type: STRING
Type: UNORDERED_LIST_STRING
transparent_data_encryption
Type: STRUCT
Provider name: LogicalDatabaseTransparentDataEncryption
id
Type: STRING
Provider name: id
Description: Resource ID.
name
Type: STRING
Provider name: name
Description: Resource name.
state
Type: STRING
Provider name: properties.state
Description: Specifies the state of the transparent data encryption.
type
Type: STRING
Provider name: type
Description: Resource type.
type
Type: STRING
Provider name: type
Description: Resource type.
zone_redundant
Type: BOOLEAN
Provider name: properties.zoneRedundant
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
