Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/tables/throughputSettings

• Latest
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep resource definition

The databaseAccounts/cassandraKeyspaces/tables/throughputSettings 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.

Resource format

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2024-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
      throughputBuckets: [
        {
          id: int
          maxThroughputPercentage: 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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings

Name	Description	Value
identity	Identity for the resource.	ManagedServiceIdentity
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/cassandraKeyspaces/tables
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

ThroughputBucketResource

Name	Description	Value
id	Represents the throughput bucket id	int (required)
maxThroughputPercentage	Represents maximum percentage throughput that can be used by the bucket	int (required)

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
throughputBuckets	Array of Throughput Bucket limits to be applied to the Cosmos DB container	ThroughputBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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

ARM template resource definition

The databaseAccounts/cassandraKeyspaces/tables/throughputSettings 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.

Resource format

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int",
      "throughputBuckets": [
        {
          "id": "int",
          "maxThroughputPercentage": "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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings

Name	Description	Value
apiVersion	The api version	'2024-12-01-preview'
identity	Identity for the resource.	ManagedServiceIdentity
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/cassandraKeyspaces/tables/throughputSettings'

Tags

Name	Description	Value

ThroughputBucketResource

Name	Description	Value
id	Represents the throughput bucket id	int (required)
maxThroughputPercentage	Represents maximum percentage throughput that can be used by the bucket	int (required)

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
throughputBuckets	Array of Throughput Bucket limits to be applied to the Cosmos DB container	ThroughputBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
        throughputBuckets = [
          {
            id = int
            maxThroughputPercentage = 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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned'
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables/throughputSettings

Name	Description	Value
identity	Identity for the resource.	ManagedServiceIdentity
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/cassandraKeyspaces/tables
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/cassandraKeyspaces/tables/throughputSettings@2024-12-01-preview"

Tags

Name	Description	Value

ThroughputBucketResource

Name	Description	Value
id	Represents the throughput bucket id	int (required)
maxThroughputPercentage	Represents maximum percentage throughput that can be used by the bucket	int (required)

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
throughputBuckets	Array of Throughput Bucket limits to be applied to the Cosmos DB container	ThroughputBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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