Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/throughputSettings 2021-04-15

  • Article
  • 2 minutes to read

The databaseAccounts/sqlDatabases/containers/throughputSettings resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2021-04-15' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
}

Property values

databaseAccounts/sqlDatabases/containers/throughputSettings

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2021-04-15'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.		 'default'
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: containers
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdateProperties (required)

ThroughputSettingsUpdateProperties

Name Description Value
resource Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. ThroughputSettingsResource (required)

ThroughputSettingsResource

Name Description Value
autoscaleSettings Cosmos DB provisioned throughput settings object AutoscaleSettingsResource
throughput Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. int

AutoscaleSettingsResource

Name Description Value
autoUpgradePolicy Cosmos DB resource auto-upgrade policy AutoUpgradePolicyResource
maxThroughput Represents maximum throughput container can scale up to. int (required)

AutoUpgradePolicyResource

Name Description Value
throughputPolicy Cosmos DB resource throughput policy ThroughputPolicyResource

ThroughputPolicyResource

Name Description Value
incrementPercent Represents the percentage by which throughput can increase every time throughput policy kicks in. int
isEnabled Determines whether the ThroughputPolicy is active or not bool