sql_container_throughputs
Creates, updates, deletes, gets or lists a sql_container_throughputs resource.
Overview
| Name | sql_container_throughputs |
| Type | Resource |
| Id | azure.cosmos_db.sql_container_throughputs |
Fields
The following fields are returned by SELECT queries:
- get
The RUs per second of the SQL container was retrieved successfully.
| Name | Datatype | Description |
|---|---|---|
id | string | The unique resource identifier of the ARM resource. |
name | string | The name of the ARM resource. |
identity | object | Identity for the resource. |
location | string | The location of the resource group to which the resource belongs. |
properties | object | The properties of an Azure Cosmos DB resource throughput |
tags | object | Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". |
type | string | The type of Azure resource. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, accountName, databaseName, containerName | Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account. | |
update | replace | subscriptionId, resourceGroupName, accountName, databaseName, containerName, data__properties | Update RUs per second of an Azure Cosmos DB SQL container |
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 |
|---|---|---|
accountName | string | Cosmos DB database account name. |
containerName | string | Cosmos DB container name. |
databaseName | string | Cosmos DB database name. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
SELECT examples
- get
Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.
SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.cosmos_db.sql_container_throughputs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND containerName = '{{ containerName }}' -- required
;
REPLACE examples
- update
Update RUs per second of an Azure Cosmos DB SQL container
REPLACE azure.cosmos_db.sql_container_throughputs
SET
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND containerName = '{{ containerName }}' --required
AND data__properties = '{{ properties }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;