Microsoft.DocumentDB throughputPools/throughputPoolAccounts 2024-09-01-preview
Bicep resource definition
The throughputPools/throughputPoolAccounts 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/throughputPoolAccounts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/throughputPools/throughputPoolAccounts@2024-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
accountLocation: 'string'
accountResourceIdentifier: 'string'
provisioningState: 'string'
}
}
Property values
Microsoft.DocumentDB/throughputPools/throughputPoolAccounts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (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:
- 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/throughputPoolAccounts resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts",
"apiVersion": "2024-09-01-preview",
"name": "string",
"properties": {
"accountLocation": "string",
"accountResourceIdentifier": "string",
"provisioningState": "string"
}
}
Property values
Microsoft.DocumentDB/throughputPools/throughputPoolAccounts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-09-01-preview' |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required) |
| properties | An Azure Cosmos DB Global Database Account which is part of a Throughputpool. | ThroughputPoolAccountProperties |
| type | The resource type | 'Microsoft.DocumentDB/throughputPools/throughputPoolAccounts' |
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@2024-09-01-preview"
name = "string"
body = jsonencode({
properties = {
accountLocation = "string"
accountResourceIdentifier = "string"
provisioningState = "string"
}
})
}
Property values
Microsoft.DocumentDB/throughputPools/throughputPoolAccounts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (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 |
| type | The resource type | "Microsoft.DocumentDB/throughputPools/throughputPoolAccounts@2024-09-01-preview" |
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' |