Microsoft.DocumentDB databaseAccounts/sqlDatabases 2024-11-15

Article
2024-12-09

Bicep resource definition

The databaseAccounts/sqlDatabases resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name	Description	Value
location	The location of the resource group to which the resource belongs.	string
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: databaseAccounts
properties	Properties to create and update Azure Cosmos DB SQL database.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceRestoreParameters

Name	Description	Value
restoreSource	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	string
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name	Description	Value
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource	The standard JSON format of a SQL database	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (required)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name	Description	Value
createMode	Enum to indicate the mode of resource creation.	'Default' 'Restore'
id	Name of the Cosmos DB SQL database	string (required)
restoreParameters	Parameters to indicate the information about the restore	ResourceRestoreParameters

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
Azure Cosmos DB account SQL API with analytical store	This template creates an Azure Cosmos account for Core (SQL) API with a database and container configured with analytical store.
Create a free-tier Azure Cosmos DB account	This template creates a free-tier Azure Cosmos DB account for SQL API with a database with shared throughput and container.
Create an Azure Cosmos DB account for Core (SQL) API	This template creates an Azure Cosmos account for Core (SQL) API with a database and container with throughput with multiple other options.
Create an Azure Cosmos DB account SQL API with autoscale	This template creates an Azure Cosmos account for Core (SQL) API with a database and container with autoscale throughput with multiple other options.
Create Azure Cosmos DB Core (SQL) API stored procedures	This template creates an Azure Cosmos DB account for Core (SQL) API and a container with a stored procedure, trigger and user defined function.
Creates a Dapr microservices app using Container Apps	Create a Dapr microservices app using Container Apps.
Creates a Dapr pub-sub servicebus app using Container Apps	Create a Dapr pub-sub servicebus app using Container Apps.
Deploy Azure Data Explorer DB with Cosmos DB connection	Deploy Azure Data Explorer DB with Cosmos DB connection.

ARM template resource definition

The databaseAccounts/sqlDatabases resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2024-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name	Description	Value
apiVersion	The api version	'2024-11-15'
location	The location of the resource group to which the resource belongs.	string
name	The resource name	string (required)
properties	Properties to create and update Azure Cosmos DB SQL database.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DocumentDB/databaseAccounts/sqlDatabases'

ResourceRestoreParameters

Name	Description	Value
restoreSource	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	string
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name	Description	Value
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource	The standard JSON format of a SQL database	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (required)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name	Description	Value
createMode	Enum to indicate the mode of resource creation.	'Default' 'Restore'
id	Name of the Cosmos DB SQL database	string (required)
restoreParameters	Parameters to indicate the information about the restore	ResourceRestoreParameters

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Cosmos DB account SQL API with analytical store	This template creates an Azure Cosmos account for Core (SQL) API with a database and container configured with analytical store.
Create a free-tier Azure Cosmos DB account	This template creates a free-tier Azure Cosmos DB account for SQL API with a database with shared throughput and container.
Create an Azure Cosmos DB account for Core (SQL) API	This template creates an Azure Cosmos account for Core (SQL) API with a database and container with throughput with multiple other options.
Create an Azure Cosmos DB account SQL API with autoscale	This template creates an Azure Cosmos account for Core (SQL) API with a database and container with autoscale throughput with multiple other options.
Create Azure Cosmos DB Core (SQL) API stored procedures	This template creates an Azure Cosmos DB account for Core (SQL) API and a container with a stored procedure, trigger and user defined function.
Creates a Dapr microservices app using Container Apps	Create a Dapr microservices app using Container Apps.
Creates a Dapr pub-sub servicebus app using Container Apps	Create a Dapr pub-sub servicebus app using Container Apps.
Deploy Azure Data Explorer DB with Cosmos DB connection	Deploy Azure Data Explorer DB with Cosmos DB connection.

Terraform (AzAPI provider) resource definition

The databaseAccounts/sqlDatabases resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  }
}

Property Values

AutoscaleSettings

Name	Description	Value
maxThroughput	Represents maximum throughput, the resource can scale up to.	int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name	Description	Value
autoscaleSettings	Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.	AutoscaleSettings
throughput	Request Units per second. For example, "throughput": 10000.	int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name	Description	Value
location	The location of the resource group to which the resource belongs.	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: databaseAccounts
properties	Properties to create and update Azure Cosmos DB SQL database.	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15"

ResourceRestoreParameters

Name	Description	Value
restoreSource	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	string
restoreTimestampInUtc	Time to which the account has to be restored (ISO-8601 format).	string
restoreWithTtlDisabled	Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.	bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name	Description	Value
options	A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource	The standard JSON format of a SQL database	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (required)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name	Description	Value
createMode	Enum to indicate the mode of resource creation.	'Default' 'Restore'
id	Name of the Cosmos DB SQL database	string (required)
restoreParameters	Parameters to indicate the information about the restore	ResourceRestoreParameters

Share via

Microsoft.DocumentDB databaseAccounts/sqlDatabases 2024-11-15

Bicep resource definition

Resource format

Property Values

AutoscaleSettings

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Tags

Usage Examples

Azure Quickstart Samples

ARM template resource definition

Resource format

Property Values

AutoscaleSettings

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Tags

Usage Examples

Azure Quickstart Templates

Terraform (AzAPI provider) resource definition

Resource format

Property Values

AutoscaleSettings

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

ResourceRestoreParameters

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Tags

Feedback

Additional resources