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

vw_throughput_pool_accounts

Name	Datatype	Description
account_instance_id	text	field from the properties object
account_location	text	field from the properties object
account_resource_identifier	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
throughputPoolAccountName	text	field from the properties object
throughputPoolName	text	field from the properties object

throughput_pool_accounts

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

Methods

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

SELECT examples

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

vw_throughput_pool_accounts

SELECT
account_instance_id,
account_location,
account_resource_identifier,
provisioning_state,
resourceGroupName,
subscriptionId,
throughputPoolAccountName,
throughputPoolName
FROM azure.cosmos_db.vw_throughput_pool_accounts
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND throughputPoolName = '{{ throughputPoolName }}';

throughput_pool_accounts

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

INSERT example

Use the following StackQL query and manifest file to create a new throughput_pool_accounts resource.

All Properties

/*+ create */
INSERT INTO azure.cosmos_db.throughput_pool_accounts (
resourceGroupName,
subscriptionId,
throughputPoolAccountName,
throughputPoolName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ throughputPoolAccountName }}',
'{{ throughputPoolName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: accountResourceIdentifier
          value: string
        - name: accountLocation
          value: string
        - name: accountInstanceId
          value: string

DELETE example

Deletes the specified throughput_pool_accounts resource.

/*+ delete */
DELETE FROM azure.cosmos_db.throughput_pool_accounts
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND throughputPoolAccountName = '{{ throughputPoolAccountName }}'
AND throughputPoolName = '{{ throughputPoolName }}';