The throughputPools 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/throughputPools resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/throughputPools",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"maxThroughput": "int",
"provisioningState": "string"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DocumentDB/throughputPools' |
apiVersion | The resource api version | '2024-02-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 |
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' |