Skip to main content

mongodb_collection_throughputs

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

Overview

Namemongodb_collection_throughputs
TypeResource
Idazure.cosmos_db.mongodb_collection_throughputs

Fields

NameDatatypeDescription
idtextThe unique resource identifier of the ARM resource.
nametextThe name of the ARM resource.
accountNametextfield from the properties object
collectionNametextfield from the properties object
databaseNametextfield from the properties object
identitytextIdentity for the resource.
locationtextThe location of the resource group to which the resource belongs.
resourcetextfield from the properties object
resourceGroupNametextfield from the properties object
subscriptionIdtextfield from the properties object
tagstextTags 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".
typetextThe type of Azure resource.

Methods

NameAccessible byRequired ParamsDescription
getSELECTaccountName, collectionName, databaseName, resourceGroupName, subscriptionIdGets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.
updateREPLACEaccountName, collectionName, databaseName, resourceGroupName, subscriptionId, data__propertiesUpdate 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.

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 }}';

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 }}';