throughput_pools

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

Overview

Name	throughput_pools
Type	Resource
Id	azure.cosmos_db.throughput_pools

Fields

vw_throughput_pools

Name	Datatype	Description
location	text	The geo-location where the resource lives
max_throughput	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
tags	text	Resource tags.
throughputPoolName	text	field from the properties object

throughput_pools

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties to update Azure Cosmos DB throughput pool.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, throughputPoolName	Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
list	SELECT	subscriptionId	Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all the ThroughputPools in a given resource group.
create_or_update	INSERT	resourceGroupName, subscriptionId, 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, throughputPoolName	Deletes an existing Azure Cosmos DB Throughput Pool.
update	UPDATE	resourceGroupName, subscriptionId, throughputPoolName	Updates the properties of an existing Azure Cosmos DB Throughput Pool.

SELECT examples

Lists all the Azure Cosmos DB Throughput Pools available under the subscription.

vw_throughput_pools

SELECT
location,
max_throughput,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
throughputPoolName
FROM azure.cosmos_db.vw_throughput_pools
WHERE subscriptionId = '{{ subscriptionId }}';

throughput_pools

SELECT
location,
properties,
tags
FROM azure.cosmos_db.throughput_pools
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: maxThroughput
          value: integer
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a throughput_pools resource.

/*+ update */
UPDATE azure.cosmos_db.throughput_pools
SET 
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND throughputPoolName = '{{ throughputPoolName }}';

DELETE example

Deletes the specified throughput_pools resource.

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