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

The following fields are returned by SELECT queries:

get

The Throughput Pool properties were retrieved successfully.

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.

list_by_resource_group

The operation completed successfully.

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.

list

The operation completed successfully.

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, throughputPoolName		Retrieves the properties of an existing Azure Cosmos DB Throughput Pool
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the ThroughputPools in a given resource group.
list	select	subscriptionId		Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
create_or_update	insert	subscriptionId, resourceGroupName, throughputPoolName		Creates or updates an Azure Cosmos DB ThroughputPool account. The "Update" method is preferred when performing updates on an account.
update	update	subscriptionId, resourceGroupName, throughputPoolName		Updates the properties of an existing Azure Cosmos DB Throughput Pool.
delete	delete	subscriptionId, resourceGroupName, throughputPoolName		Deletes an existing Azure Cosmos DB 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.
throughputPoolName	string	Cosmos DB Throughput Pool name.

SELECT examples

get

Retrieves the properties of an existing Azure Cosmos DB Throughput Pool

SELECT
location,
properties,
tags
FROM azure.cosmos_db.throughput_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND throughputPoolName = '{{ throughputPoolName }}' -- required
;

list_by_resource_group

List all the ThroughputPools in a given resource group.

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

list

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

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

INSERT examples

create_or_update

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_pools (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
throughputPoolName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ throughputPoolName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: throughput_pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the throughput_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the throughput_pools resource.
    - name: throughputPoolName
      value: string
      description: Required parameter for the throughput_pools resource.
    - name: properties
      value: object
      description: |
        Properties to update Azure Cosmos DB throughput pool.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the properties of an existing Azure Cosmos DB Throughput Pool.

UPDATE azure.cosmos_db.throughput_pools
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND throughputPoolName = '{{ throughputPoolName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes an existing Azure Cosmos DB Throughput Pool.

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