Microsoft.DocumentDB databaseAccounts/tables 2021-01-15

Template format

To create a Microsoft.DocumentDB/databaseAccounts/tables resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.DocumentDB/databaseAccounts/tables",
  "apiVersion": "2021-01-15",
  "location": "string",
  "tags": {},
  "properties": {
    "resource": {
      "id": "string"
    },
    "options": {
      "throughput": "integer",
      "autoscaleSettings": {
        "maxThroughput": "integer"
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DocumentDB/databaseAccounts/tables object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Cosmos DB table name.
type enum Yes For JSON -tables
-or-
Microsoft.DocumentDB/databaseAccounts/tables

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2021-01-15
location string No The location of the resource group to which the resource belongs.
tags object No
properties object Yes Properties to create and update Azure Cosmos DB Table. - TableCreateUpdateProperties object

TableCreateUpdateProperties object

Name Type Required Value
resource object Yes The standard JSON format of a Table - TableResource object
options object No A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. - CreateUpdateOptions object

TableResource object

Name Type Required Value
id string Yes Name of the Cosmos DB table

CreateUpdateOptions object

Name Type Required Value
throughput integer No Request Units per second. For example, "throughput": 10000.
autoscaleSettings object No Specifies the Autoscale settings. - AutoscaleSettings object

AutoscaleSettings object

Name Type Required Value
maxThroughput integer No Represents maximum throughput, the resource can scale up to.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos account for Table API

Deploy to Azure
This template creates an Azure Cosmos DB account for Table API in two regions and a single table with provisioned throughput.
Create an Azure Cosmos account for Table API with autoscale

Deploy to Azure
This template creates an Azure Cosmos DB account for Table API in two regions and a single table with autoscale throughput.