Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/throughputSettings 2024-02-15-preview
Article 12/09/2024
2 contributors
Feedback
In this article
Bicep resource definition
The databaseAccounts/sqlDatabases/containers/throughputSettings resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2024-02-15-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
}
}
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
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
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings
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
ARM template resource definition
The databaseAccounts/sqlDatabases/containers/throughputSettings resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings",
"apiVersion": "2024-02-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"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
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
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
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings
Name
Description
Value
apiVersion
The api version
'2024-02-15-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/sqlDatabases/containers/throughputSettings'
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
The databaseAccounts/sqlDatabases/containers/throughputSettings resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/throughputSettings@2024-02-15-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
}
}
})
}
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
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
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/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/sqlDatabases/containers
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/containers/throughputSettings@2024-02-15-preview"
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