Partager via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/throughputSettings 2024-11-15

  • 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@2024-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name 'default' (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/sqlDatabases
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Tags

Name Description Value

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

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

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

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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

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": "2024-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings

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 'default' (required)
properties Properties to update Azure Cosmos DB resource throughput. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings'

Tags

Name Description Value

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

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

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

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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

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@2024-11-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

Property values

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings

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

Tags

Name Description Value

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

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

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

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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