Microsoft.DocumentDB databaseAccounts/sqlDatabases 2019-12-12
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.
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-12-12' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
options: {
throughput: 'string'
{customized property}: 'string'
}
resource: {
id: 'string'
}
}
}
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
location | The location of the resource group to which the resource belongs. | string |
tags | Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". | Dictionary of tag names and values. See Tags in templates |
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. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (required) |
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. | CreateUpdateOptions (required) |
resource | The standard JSON format of a SQL database | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (required) |
Name | Description | Value |
---|---|---|
throughput | Request Units per second. For example, "throughput": "10000". | string |
{customized property} | string |
Name | Description | Value |
---|---|---|
id | Name of the Cosmos DB SQL database | string (required) |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
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. |
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 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. |
Deploy Azure Data Explorer DB with Cosmos DB connection |
Deploy Azure Data Explorer DB with Cosmos DB connection. |
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.
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2019-12-12",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"options": {
"throughput": "string",
"{customized property}": "string"
},
"resource": {
"id": "string"
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
apiVersion | The resource api version | '2019-12-12' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
location | The location of the resource group to which the resource belongs. | string |
tags | Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". | Dictionary of tag names and values. See Tags in templates |
properties | Properties to create and update Azure Cosmos DB SQL database. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (required) |
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. | CreateUpdateOptions (required) |
resource | The standard JSON format of a SQL database | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (required) |
Name | Description | Value |
---|---|---|
throughput | Request Units per second. For example, "throughput": "10000". | string |
{customized property} | string |
Name | Description | Value |
---|---|---|
id | Name of the Cosmos DB SQL database | string (required) |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
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. |
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 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. |
Deploy Azure Data Explorer DB with Cosmos DB connection |
Deploy Azure Data Explorer DB with Cosmos DB connection. |
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.
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-12-12"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
options = {
throughput = "string"
{customized property} = "string"
}
resource = {
id = "string"
}
}
})
}
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2019-12-12" |
name | The resource name | string (required) |
location | The location of the resource group to which the resource belongs. | string |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: databaseAccounts |
tags | Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". | Dictionary of tag names and values. |
properties | Properties to create and update Azure Cosmos DB SQL database. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (required) |
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. | CreateUpdateOptions (required) |
resource | The standard JSON format of a SQL database | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (required) |
Name | Description | Value |
---|---|---|
throughput | Request Units per second. For example, "throughput": "10000". | string |
{customized property} | string |
Name | Description | Value |
---|---|---|
id | Name of the Cosmos DB SQL database | string (required) |