Share via

Microsoft.DocumentDB throughputPools 2024-05-15-preview

  • Article

Bicep resource definition

The throughputPools resource type can be deployed with operations that target:

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' = {
  location: 'string'
  name: 'string'
  properties: {
    maxThroughput: int
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.DocumentDB/throughputPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required)
properties Properties to update Azure Cosmos DB throughput pool. ThroughputPoolProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

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'

TrackedResourceTags

Name Description Value

ARM template resource definition

The throughputPools resource type can be deployed with operations that target:

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",
  "properties": {
    "maxThroughput": "int",
    "provisioningState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.DocumentDB/throughputPools

Name Description Value
apiVersion The api version '2024-05-15-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required)
properties Properties to update Azure Cosmos DB throughput pool. ThroughputPoolProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/throughputPools'

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'

TrackedResourceTags

Name Description Value

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"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      maxThroughput = int
      provisioningState = "string"
    }
  })
}

Property values

Microsoft.DocumentDB/throughputPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required)
properties Properties to update Azure Cosmos DB throughput pool. ThroughputPoolProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/throughputPools@2024-05-15-preview"

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'

TrackedResourceTags

Name Description Value