Microsoft.DocumentDB databaseAccounts/apis/databases/collections/settings 2015-11-06
Bicep resource definition
The databaseAccounts/apis/databases/collections/settings 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/apis/databases/collections/settings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-11-06' = {
parent: resourceSymbolicName
name: 'throughput'
properties: {
resource: {
throughput: int
}
}
}
Property values
Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'throughput' (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/apis/databases/collections |
| properties | Properties to update Azure Cosmos DB resource throughput. | ThroughputUpdatePropertiesOrThroughputProperties (required) |
ThroughputResource
| Name | Description | Value |
|---|---|---|
| throughput | Value of the Cosmos DB resource throughput | int (required) |
ThroughputUpdatePropertiesOrThroughputProperties
| Name | Description | Value |
|---|---|---|
| resource | The standard JSON format of a resource throughput | ThroughputResource (required) |
ARM template resource definition
The databaseAccounts/apis/databases/collections/settings 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/apis/databases/collections/settings resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings",
"apiVersion": "2015-11-06",
"name": "string",
"properties": {
"resource": {
"throughput": "int"
}
}
}
Property values
Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-11-06' |
| name | The resource name | 'throughput' (required) |
| properties | Properties to update Azure Cosmos DB resource throughput. | ThroughputUpdatePropertiesOrThroughputProperties (required) |
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings' |
ThroughputResource
| Name | Description | Value |
|---|---|---|
| throughput | Value of the Cosmos DB resource throughput | int (required) |
ThroughputUpdatePropertiesOrThroughputProperties
| Name | Description | Value |
|---|---|---|
| resource | The standard JSON format of a resource throughput | ThroughputResource (required) |
Terraform (AzAPI provider) resource definition
The databaseAccounts/apis/databases/collections/settings 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/apis/databases/collections/settings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-11-06"
name = "string"
body = jsonencode({
properties = {
resource = {
throughput = int
}
}
})
}
Property values
Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'throughput' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: databaseAccounts/apis/databases/collections |
| properties | Properties to update Azure Cosmos DB resource throughput. | ThroughputUpdatePropertiesOrThroughputProperties (required) |
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings@2015-11-06" |
ThroughputResource
| Name | Description | Value |
|---|---|---|
| throughput | Value of the Cosmos DB resource throughput | int (required) |
ThroughputUpdatePropertiesOrThroughputProperties
| Name | Description | Value |
|---|---|---|
| resource | The standard JSON format of a resource throughput | ThroughputResource (required) |