Microsoft.DocumentDB throughputPools/throughputPoolAccounts

ARM template resource definition

The throughputPools/throughputPoolAccounts 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/throughputPoolAccounts resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "properties": {
    "accountLocation": "string",
    "accountResourceIdentifier": "string",
    "provisioningState": "string"
  }
}

Property values

throughputPools/throughputPoolAccounts

Name Description Value
type The resource type 'Microsoft.DocumentDB/throughputPools/throughputPoolAccounts'
apiVersion The resource api version '2024-02-15-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties An Azure Cosmos DB Global Database Account which is part of a Throughputpool. ThroughputPoolAccountProperties

ThroughputPoolAccountProperties

Name Description Value
accountLocation The location of global database account in the throughputPool. string
accountResourceIdentifier The resource identifier of global database account in the throughputPool. string
provisioningState A provisioning state of the ThroughputPool Account. 'Canceled'
'Deleting'
'Failed'
'Initializing'
'InternallyReady'
'Online'
'Succeeded'
'Uninitialized'
'Updating'