Skip to main content

mongodb_collections

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

Overview

Namemongodb_collections
TypeResource
Idazure.cosmos_db.mongodb_collections

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.
optionstextfield from the properties object
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 MongoDB collection under an existing Azure Cosmos DB database account.
listSELECTaccountName, databaseName, resourceGroupName, subscriptionIdLists the MongoDB collection under an existing Azure Cosmos DB database account.
create_updateINSERTaccountName, collectionName, databaseName, resourceGroupName, subscriptionId, data__propertiesCreate or update an Azure Cosmos DB MongoDB Collection
deleteDELETEaccountName, collectionName, databaseName, resourceGroupName, subscriptionIdDeletes an existing Azure Cosmos DB MongoDB Collection.

SELECT examples

Lists the MongoDB collection under an existing Azure Cosmos DB database account.

SELECT
id,
name,
accountName,
collectionName,
databaseName,
identity,
location,
options,
resource,
resourceGroupName,
subscriptionId,
tags,
type
FROM azure.cosmos_db.vw_mongodb_collections
WHERE accountName = '{{ accountName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

/*+ create */
INSERT INTO azure.cosmos_db.mongodb_collections (
accountName,
collectionName,
databaseName,
resourceGroupName,
subscriptionId,
data__properties,
properties,
location,
tags,
identity
)
SELECT
'{{ accountName }}',
'{{ collectionName }}',
'{{ databaseName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}'
;

DELETE example

Deletes the specified mongodb_collections resource.

/*+ delete */
DELETE FROM azure.cosmos_db.mongodb_collections
WHERE accountName = '{{ accountName }}'
AND collectionName = '{{ collectionName }}'
AND databaseName = '{{ databaseName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';