Microsoft.DocumentDB databaseAccounts/tables/throughputSettings 2023-03-01-preview
- Latest
- 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/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/tables/throughputSettings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2023-03-01-preview' = {
name: 'default'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
resource: {
autoscaleSettings: {
autoUpgradePolicy: {
throughputPolicy: {
incrementPercent: int
isEnabled: bool
}
}
maxThroughput: int
}
throughput: int
}
}
}
Property values
databaseAccounts/tables/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: tables |
identity | Identity for the resource. | ManagedServiceIdentity |
properties | Properties to update Azure Cosmos DB resource throughput. | ThroughputSettingsUpdatePropertiesOrThroughputSettin... (required) |
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 |
---|---|---|
{customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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/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/tables/throughputSettings resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
"apiVersion": "2023-03-01-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"
}
}
}
Property values
databaseAccounts/tables/throughputSettings
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings' |
apiVersion | The resource api version | '2023-03-01-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) |
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 |
---|---|---|
{customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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/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/tables/throughputSettings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2023-03-01-preview"
name = "default"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
resource = {
autoscaleSettings = {
autoUpgradePolicy = {
throughputPolicy = {
incrementPercent = int
isEnabled = bool
}
}
maxThroughput = int
}
throughput = int
}
}
})
}
Property values
databaseAccounts/tables/throughputSettings
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings@2023-03-01-preview" |
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: tables |
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. |
identity | Identity for the resource. | ManagedServiceIdentity |
properties | Properties to update Azure Cosmos DB resource throughput. | ThroughputSettingsUpdatePropertiesOrThroughputSettin... (required) |
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. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
identity_ids | 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}'. | Array of user identity IDs. |
ManagedServiceIdentityUserAssignedIdentities
Name | Description | Value |
---|---|---|
{customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for