Microsoft.DocumentDB throughputPools
Bicep resource definition
The throughputPools 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/throughputPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/throughputPools@2024-05-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
maxThroughput: int
provisioningState: 'string'
}
}
Property values
throughputPools
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Properties to update Azure Cosmos DB throughput pool. | ThroughputPoolProperties |
ThroughputPoolProperties
| Name | Description | Value |
|---|---|---|
| maxThroughput | Value for throughput to be shared among CosmosDB resources in the pool. | int |
| provisioningState | A provisioning state of the ThroughputPool. | 'Canceled' 'Deleting' 'Failed' 'Initializing' 'InternallyReady' 'Online' 'Succeeded' 'Uninitialized' 'Updating' |
ARM template resource definition
The throughputPools 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/throughputPools resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/throughputPools",
"apiVersion": "2024-05-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"maxThroughput": "int",
"provisioningState": "string"
}
}
Property values
throughputPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DocumentDB/throughputPools' |
| apiVersion | The resource api version | '2024-05-15-preview' |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| properties | Properties to update Azure Cosmos DB throughput pool. | ThroughputPoolProperties |
ThroughputPoolProperties
| Name | Description | Value |
|---|---|---|
| maxThroughput | Value for throughput to be shared among CosmosDB resources in the pool. | int |
| provisioningState | A provisioning state of the ThroughputPool. | 'Canceled' 'Deleting' 'Failed' 'Initializing' 'InternallyReady' 'Online' 'Succeeded' 'Uninitialized' 'Updating' |
Terraform (AzAPI provider) resource definition
The throughputPools 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/throughputPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/throughputPools@2024-05-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
maxThroughput = int
provisioningState = "string"
}
})
}
Property values
throughputPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DocumentDB/throughputPools@2024-05-15-preview" |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| properties | Properties to update Azure Cosmos DB throughput pool. | ThroughputPoolProperties |
ThroughputPoolProperties
| Name | Description | Value |
|---|---|---|
| maxThroughput | Value for throughput to be shared among CosmosDB resources in the pool. | int |
| provisioningState | A provisioning state of the ThroughputPool. | "Canceled" "Deleting" "Failed" "Initializing" "InternallyReady" "Online" "Succeeded" "Uninitialized" "Updating" |