mongodb_resources

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

Overview

Name	mongodb_resources
Type	Resource
Id	azure.cosmos_db.mongodb_resources

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
retrieve_continuous_backup_information	exec	subscriptionId, resourceGroupName, accountName, databaseName, collectionName		Retrieves continuous backup information for a Mongodb collection.
migrate_mongodb_database_to_autoscale	exec	subscriptionId, resourceGroupName, accountName, databaseName		Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
migrate_mongodb_database_to_manual_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName		Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput
mongodb_database_retrieve_throughput_distribution	exec	subscriptionId, resourceGroupName, accountName, databaseName, properties		Retrieve throughput distribution for an Azure Cosmos DB MongoDB database
mongodb_database_redistribute_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, properties		Redistribute throughput for an Azure Cosmos DB MongoDB database
mongodb_container_retrieve_throughput_distribution	exec	subscriptionId, resourceGroupName, accountName, databaseName, collectionName, properties		Retrieve throughput distribution for an Azure Cosmos DB MongoDB container
mongodb_container_redistribute_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, collectionName, properties		Redistribute throughput for an Azure Cosmos DB MongoDB container
mongodb_database_partition_merge	exec	subscriptionId, resourceGroupName, accountName, databaseName		Merges the partitions of a MongoDB database
migrate_mongodb_collection_to_autoscale	exec	subscriptionId, resourceGroupName, accountName, databaseName, collectionName		Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
migrate_mongodb_collection_to_manual_throughput	exec	subscriptionId, resourceGroupName, accountName, databaseName, collectionName		Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

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.
collectionName	string	Cosmos DB collection 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.

Lifecycle Methods

retrieve_continuous_backup_information

Retrieves continuous backup information for a Mongodb collection.

EXEC azure.cosmos_db.mongodb_resources.retrieve_continuous_backup_information 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@collectionName='{{ collectionName }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;

migrate_mongodb_database_to_autoscale

Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

EXEC azure.cosmos_db.mongodb_resources.migrate_mongodb_database_to_autoscale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required
;

migrate_mongodb_database_to_manual_throughput

Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

EXEC azure.cosmos_db.mongodb_resources.migrate_mongodb_database_to_manual_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required
;

mongodb_database_retrieve_throughput_distribution

Retrieve throughput distribution for an Azure Cosmos DB MongoDB database

EXEC azure.cosmos_db.mongodb_resources.mongodb_database_retrieve_throughput_distribution 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

mongodb_database_redistribute_throughput

Redistribute throughput for an Azure Cosmos DB MongoDB database

EXEC azure.cosmos_db.mongodb_resources.mongodb_database_redistribute_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

mongodb_container_retrieve_throughput_distribution

Retrieve throughput distribution for an Azure Cosmos DB MongoDB container

EXEC azure.cosmos_db.mongodb_resources.mongodb_container_retrieve_throughput_distribution 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@collectionName='{{ collectionName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

mongodb_container_redistribute_throughput

Redistribute throughput for an Azure Cosmos DB MongoDB container

EXEC azure.cosmos_db.mongodb_resources.mongodb_container_redistribute_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@collectionName='{{ collectionName }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}"
}'
;

mongodb_database_partition_merge

Merges the partitions of a MongoDB database

EXEC azure.cosmos_db.mongodb_resources.mongodb_database_partition_merge 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required 
@@json=
'{
"isDryRun": {{ isDryRun }}
}'
;

migrate_mongodb_collection_to_autoscale

Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

EXEC azure.cosmos_db.mongodb_resources.migrate_mongodb_collection_to_autoscale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@collectionName='{{ collectionName }}' --required
;

migrate_mongodb_collection_to_manual_throughput

Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

EXEC azure.cosmos_db.mongodb_resources.migrate_mongodb_collection_to_manual_throughput 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@collectionName='{{ collectionName }}' --required
;