Share via

Microsoft.DocumentDB throughputPools/throughputPoolAccounts 2023-11-15-preview

  • Article

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/throughputPools/throughputPoolAccounts@2023-11-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    accountLocation: 'string'
    accountResourceIdentifier: 'string'
    provisioningState: 'string'
  }
}

Property values

throughputPools/throughputPoolAccounts

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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: throughputPools
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'

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": "2023-11-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 '2023-11-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'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts@2023-11-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      accountLocation = "string"
      accountResourceIdentifier = "string"
      provisioningState = "string"
    }
  })
}

Property values

throughputPools/throughputPoolAccounts

Name Description Value
type The resource type "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts@2023-11-15-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: throughputPools
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"