Share via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/throughputSettings 2020-09-01

  • Article

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-09-01' = {
  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/throughputSettings

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 '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: sqlDatabases
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (required)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Description Value
resource The standard JSON format of a resource throughput ThroughputSettingsResourceOrThroughputSettingsGetPro... (required)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Description Value
autoscaleSettings Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. 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 Represents throughput policy which service must adhere to for auto-upgrade 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

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
  "apiVersion": "2020-09-01",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  }
}

Property values

databaseAccounts/sqlDatabases/throughputSettings

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings'
apiVersion The resource api version '2020-09-01'
name The resource name

See how to set names and types for child resources in 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
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (required)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Description Value
resource The standard JSON format of a resource throughput ThroughputSettingsResourceOrThroughputSettingsGetPro... (required)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Description Value
autoscaleSettings Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. 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 Represents throughput policy which service must adhere to for auto-upgrade 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

Terraform (AzAPI provider) resource definition

The databaseAccounts/sqlDatabases/throughputSettings 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/throughputSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-09-01"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

Property values

databaseAccounts/sqlDatabases/throughputSettings

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2020-09-01"
name The resource name "default"
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: sqlDatabases
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 update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (required)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Description Value
resource The standard JSON format of a resource throughput ThroughputSettingsResourceOrThroughputSettingsGetPro... (required)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Description Value
autoscaleSettings Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. 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 Represents throughput policy which service must adhere to for auto-upgrade 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