mongodb_collection_throughputs
Creates, updates, deletes, gets or lists a mongodb_collection_throughputs
resource.
Overview
Name | mongodb_collection_throughputs |
Type | Resource |
Id | azure.cosmos_db.mongodb_collection_throughputs |
Fields
- vw_mongodb_collection_throughputs
- mongodb_collection_throughputs
Name | Datatype | Description |
---|---|---|
id | text | The unique resource identifier of the ARM resource. |
name | text | The name of the ARM resource. |
accountName | text | field from the properties object |
collectionName | text | field from the properties object |
databaseName | text | field from the properties object |
identity | text | Identity for the resource. |
location | text | The location of the resource group to which the resource belongs. |
resource | text | field from the properties object |
resourceGroupName | text | field from the properties object |
subscriptionId | text | field from the properties object |
tags | text | 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 | text | The type of Azure resource. |
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
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | accountName, collectionName, databaseName, resourceGroupName, subscriptionId | Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name. |
update | REPLACE | accountName, collectionName, databaseName, resourceGroupName, subscriptionId, data__properties | Update the RUs per second of an Azure Cosmos DB MongoDB collection |
SELECT
examples
Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.
- vw_mongodb_collection_throughputs
- mongodb_collection_throughputs
SELECT
id,
name,
accountName,
collectionName,
databaseName,
identity,
location,
resource,
resourceGroupName,
subscriptionId,
tags,
type
FROM azure.cosmos_db.vw_mongodb_collection_throughputs
WHERE accountName = '{{ accountName }}'
AND collectionName = '{{ collectionName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.cosmos_db.mongodb_collection_throughputs
WHERE accountName = '{{ accountName }}'
AND collectionName = '{{ collectionName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
REPLACE
example
Replaces all fields in the specified mongodb_collection_throughputs
resource.
/*+ update */
REPLACE azure.cosmos_db.mongodb_collection_throughputs
SET
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE
accountName = '{{ accountName }}'
AND collectionName = '{{ collectionName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND data__properties = '{{ data__properties }}';