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.
To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
"apiVersion": "2024-02-15-preview",
"name": "default",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"resource": {
"autoscaleSettings": {
"autoUpgradePolicy": {
"throughputPolicy": {
"incrementPercent": "int",
"isEnabled": "bool"
}
},
"maxThroughput": "int"
},
"throughput": "int"
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings' |
apiVersion | The resource api version | '2024-02-15-preview' |
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 |
identity | Identity for the resource. | ManagedServiceIdentity |
properties | Properties to update Azure Cosmos DB resource throughput. | ThroughputSettingsUpdatePropertiesOrThroughputSettin... (required) |
Name | Description | Value |
---|---|---|
type | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': 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. |
|
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 |
Name | Description | Value |
---|---|---|
{customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
Name | Description | Value |
---|---|---|
resource | The standard JSON format of a resource throughput | ThroughputSettingsResourceOrThroughputSettingsGetPro... (required) |
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 |
Name | Description | Value |
---|---|---|
autoUpgradePolicy | Cosmos DB resource auto-upgrade policy | AutoUpgradePolicyResource |
maxThroughput | Represents maximum throughput container can scale up to. | int (required) |
Name | Description | Value |
---|---|---|
throughputPolicy | Represents throughput policy which service must adhere to for auto-upgrade | 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 |