throughput_pool_accounts

Creates, updates, deletes, gets or lists a throughput_pool_accounts resource.

Overview

Name	throughput_pool_accounts
Type	Resource
Id	azure.cosmos_db.throughput_pool_accounts

Fields

The following fields are returned by SELECT queries:

get

The Throughput Pool properties were retrieved successfully.

Name	Datatype	Description
properties	object	An Azure Cosmos DB Global Database Account which is part of a Throughputpool.

list

The operation completed successfully.

Name	Datatype	Description
properties	object	An Azure Cosmos DB Global Database Account which is part of a Throughputpool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, throughputPoolName, throughputPoolAccountName		Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
list	select	subscriptionId, resourceGroupName, throughputPoolName		Lists all the Azure Cosmos DB accounts available under the subscription.
create	insert	subscriptionId, resourceGroupName, throughputPoolName, throughputPoolAccountName		Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
delete	delete	subscriptionId, resourceGroupName, throughputPoolName, throughputPoolAccountName		Removes an existing Azure Cosmos DB database account from a throughput pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
throughputPoolAccountName	string	Cosmos DB global database account in a Throughput Pool
throughputPoolName	string	Cosmos DB Throughput Pool name.

SELECT examples

get

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

SELECT
properties
FROM azure.cosmos_db.throughput_pool_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND throughputPoolName = '{{ throughputPoolName }}' -- required
AND throughputPoolAccountName = '{{ throughputPoolAccountName }}' -- required
;

list

Lists all the Azure Cosmos DB accounts available under the subscription.

SELECT
properties
FROM azure.cosmos_db.throughput_pool_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND throughputPoolName = '{{ throughputPoolName }}' -- required
;

INSERT examples

create

Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.

INSERT INTO azure.cosmos_db.throughput_pool_accounts (
data__properties,
subscriptionId,
resourceGroupName,
throughputPoolName,
throughputPoolAccountName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ throughputPoolName }}',
'{{ throughputPoolAccountName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: throughput_pool_accounts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the throughput_pool_accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the throughput_pool_accounts resource.
    - name: throughputPoolName
      value: string
      description: Required parameter for the throughput_pool_accounts resource.
    - name: throughputPoolAccountName
      value: string
      description: Required parameter for the throughput_pool_accounts resource.
    - name: properties
      value: object
      description: |
        An Azure Cosmos DB Global Database Account which is part of a Throughputpool.

DELETE examples

delete

Removes an existing Azure Cosmos DB database account from a throughput pool.

DELETE FROM azure.cosmos_db.throughput_pool_accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND throughputPoolName = '{{ throughputPoolName }}' --required
AND throughputPoolAccountName = '{{ throughputPoolAccountName }}' --required
;