Idem.AZURE.SQL_DATABASE.DATABASES

Idem.AZURE.SQL_DATABASE.DATABASES
Idem.AZURE.SQL_DATABASE.DATABASES
JSON Example
{
    "account": "string",
    "auto_pause_delay": 0,
    "catalog_collation": "string",
    "collation": "string",
    "count": 0,
    "create_mode": "string",
    "database_name": "string",
    "elastic_pool_id": "string",
    "federated_client_id": "string",
    "high_availability_replica_count": 0,
    "identity": {
        "tenant_id": "string",
        "type": "string"
    },
    "is_ledger_on": false,
    "license_type": "string",
    "location": "string",
    "long_term_retention_backup_resource_id": "string",
    "maintenance_configuration_id": "string",
    "max_size_bytes": 0,
    "name": "string",
    "read_scale": "string",
    "recoverable_database_id": "string",
    "recovery_services_recovery_point_id": "string",
    "requested_backup_storage_redundancy": "string",
    "resource_group_name": "string",
    "resource_id": "string",
    "restorable_dropped_database_id": "string",
    "restore_point_in_time": "string",
    "sample_name": "string",
    "secondary_type": "string",
    "server_name": "string",
    "sku": {
        "capacity": 0,
        "family": "string",
        "name": "string",
        "size": "string",
        "tier": "string"
    },
    "source_database_deletion_date": "string",
    "source_database_id": "string",
    "source_resource_id": "string",
    "subscription_id": "string",
    "zone_redundant": false
}
string
account
Required

The name of the vRA cloud account to use during provisioning

integer
auto_pause_delay
Optional

Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

string
catalog_collation
Optional

Collation of the metadata catalog.

string
collation
Optional

The collation of the database.

integer
count
Optional

The number of resource instances to be created.

string
create_mode
Optional

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.

string
database_name
Optional

The name of the database.

string
elastic_pool_id
Optional

The resource identifier of the elastic pool containing this database.

string
federated_client_id
Optional

The Client id used for cross tenant per database CMK scenario

integer
high_availability_replica_count
Optional

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.

object
identity
Optional

The Azure Active Directory identity of the database.

boolean
is_ledger_on
Optional

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.

string
license_type
Optional

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.

string
location
Required

Resource location.

string
long_term_retention_backup_resource_id
Optional

The resource identifier of the long term retention backup associated with create operation of this database.

string
maintenance_configuration_id
Optional

Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

integer
max_size_bytes
Optional

The max size of the database expressed in bytes.

min_capacity
Optional

Minimal capacity that database will always have allocated, if not paused

string
name
Required

The identifier for this state.

string
read_scale
Optional

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.

string
recoverable_database_id
Optional

The resource identifier of the recoverable database associated with create operation of this database.

string
recovery_services_recovery_point_id
Optional

The resource identifier of the recovery point associated with create operation of this database.

string
requested_backup_storage_redundancy
Optional

The storage account type to be used to store backups for this database.

string
resource_group_name
Optional

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

string
resource_id
Optional

SQL Database resource id on Azure

string
restorable_dropped_database_id
Optional

The resource identifier of the restorable dropped database associated with create operation of this database.

string
restore_point_in_time
Optional

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

string
sample_name
Optional

The name of the sample schema to apply when creating this database.

string
secondary_type
Optional

The secondary type of the database if it is a secondary. Valid values are Geo and Named.

string
server_name
Optional

The name of the server.

object
sku
Optional

The database SKU.

string
source_database_deletion_date
Optional

Specifies the time that the database was deleted.

string
source_database_id
Optional

The resource identifier of the source database associated with create operation of this database.

string
source_resource_id
Optional

The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. 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 the 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. 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

string
subscription_id
Optional

The subscription ID that identifies an Azure subscription.

object
tags
Optional

Resource tags.

boolean
zone_redundant
Optional

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.