Share via

az cosmosdb mongodb

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage MongoDB resources of Azure Cosmos DB account.

Commands

Name Description Type Status
az cosmosdb mongodb collection

Manage Azure Cosmos DB MongoDB collections.

 Core and Extension GA
az cosmosdb mongodb collection create

Create an MongoDB collection under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb collection delete

Delete the MongoDB collection under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb collection exists

Checks if an Azure Cosmos DB MongoDB collection exists.

 Core GA
az cosmosdb mongodb collection list

List the MongoDB collections under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb collection merge

Merges the partitions of a mongodb collection.

 Extension Preview
az cosmosdb mongodb collection redistribute-partition-throughput

Redistributes the partition throughput of a mongodb collection.

 Extension Preview
az cosmosdb mongodb collection restore

Restore a deleted mongodb collection within the same account.

 Core GA
az cosmosdb mongodb collection restore (cosmosdb-preview extension)

Restore a deleted mongodb collection within the same account.

 Extension Preview
az cosmosdb mongodb collection retrieve-partition-throughput

Retrieve the partition throughput of a mongodb collection.

 Extension Preview
az cosmosdb mongodb collection show

Show the details of a MongoDB collection under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb collection throughput

Manage throughput of MongoDB collection under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb collection throughput migrate

Migrate the throughput of the MongoDB collection between autoscale and manually provisioned.

 Core GA
az cosmosdb mongodb collection throughput show

Get the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb collection throughput update

Update the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb collection update

Update an MongoDB collection under an Azure Cosmos DB MongoDB database.

 Core GA
az cosmosdb mongodb database

Manage Azure Cosmos DB MongoDB databases.

 Core and Extension GA
az cosmosdb mongodb database create

Create an MongoDB database under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb database delete

Delete the MongoDB database under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb database exists

Checks if an Azure Cosmos DB MongoDB database exists.

 Core GA
az cosmosdb mongodb database list

List the MongoDB databases under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb database merge

Merges the partitions of a mongodb database.

 Extension Preview
az cosmosdb mongodb database restore

Restore a deleted mongodb database within the same account.

 Core GA
az cosmosdb mongodb database restore (cosmosdb-preview extension)

Restore a deleted mongodb database within the same account.

 Extension Preview
az cosmosdb mongodb database show

Show the details of a MongoDB database under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb database throughput

Manage throughput of MongoDB database under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb database throughput migrate

Migrate the throughput of the MongoDB database between autoscale and manually provisioned.

 Core GA
az cosmosdb mongodb database throughput show

Get the throughput of the MongoDB database under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb database throughput update

Update the throughput of the MongoDB database under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb restorable-collection

Manage different versions of mongodb collections that are restorable in a database of a Azure Cosmos DB account.

 Core and Extension GA
az cosmosdb mongodb restorable-collection list

List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account.

 Core GA
az cosmosdb mongodb restorable-collection list (cosmosdb-preview extension)

List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account.

 Extension Preview
az cosmosdb mongodb restorable-database

Manage different versions of mongodb databases that are restorable in a Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb restorable-database list

List all the versions of all the mongodb databases that were created / modified / deleted in the given restorable account.

 Core GA
az cosmosdb mongodb restorable-resource

Manage the databases and its collections that can be restored in the given account at the given timesamp and region.

 Core GA
az cosmosdb mongodb restorable-resource list

List all the databases and its collections that can be restored in the given account at the given timesamp and region.

 Core GA
az cosmosdb mongodb retrieve-latest-backup-time

Retrieves latest restorable timestamp for the given mongodb collection in given region.

 Core GA
az cosmosdb mongodb role

Manage Azure Cosmos DB Mongo role resources.

 Core and Extension GA
az cosmosdb mongodb role definition

Manage Azure Cosmos DB Mongo role definitions.

 Core and Extension GA
az cosmosdb mongodb role definition create

Create a Mongo DB role definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb role definition create (cosmosdb-preview extension)

Create a Mongo DB role definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb role definition delete

Delete a CosmosDb MongoDb role definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb role definition delete (cosmosdb-preview extension)

Delete a CosmosDb MongoDb role definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb role definition exists

Check if an Azure Cosmos DB MongoDb role definition exists.

 Core GA
az cosmosdb mongodb role definition exists (cosmosdb-preview extension)

Check if an Azure Cosmos DB MongoDb role definition exists.

 Extension GA
az cosmosdb mongodb role definition list

List all MongoDb role definitions under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb role definition list (cosmosdb-preview extension)

List all MongoDb role definitions under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb role definition show

Show the properties of a MongoDb role definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb role definition show (cosmosdb-preview extension)

Show the properties of a MongoDb role definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb role definition update

Update a MongoDb role definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb role definition update (cosmosdb-preview extension)

Update a MongoDb role definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb user

Manage Azure Cosmos DB Mongo user resources.

 Core and Extension GA
az cosmosdb mongodb user definition

Manage Azure Cosmos DB Mongo user definitions.

 Core and Extension GA
az cosmosdb mongodb user definition create

Create a Mongo DB user definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb user definition create (cosmosdb-preview extension)

Create a Mongo DB user definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb user definition delete

Delete a CosmosDb MongoDb user definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb user definition delete (cosmosdb-preview extension)

Delete a CosmosDb MongoDb user definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb user definition exists

Check if an Azure Cosmos DB MongoDb user definition exists.

 Core GA
az cosmosdb mongodb user definition exists (cosmosdb-preview extension)

Check if an Azure Cosmos DB MongoDb user definition exists.

 Extension GA
az cosmosdb mongodb user definition list

List all MongoDb user definitions under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb user definition list (cosmosdb-preview extension)

List all MongoDb user definitions under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb user definition show

Show the properties of a MongoDb user definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb user definition show (cosmosdb-preview extension)

Show the properties of a MongoDb user definition under an Azure Cosmos DB account.

 Extension GA
az cosmosdb mongodb user definition update

Update a MongoDb user definition under an Azure Cosmos DB account.

 Core GA
az cosmosdb mongodb user definition update (cosmosdb-preview extension)

Update a MongoDb user definition under an Azure Cosmos DB account.

 Extension GA

az cosmosdb mongodb retrieve-latest-backup-time

Edit

Retrieves latest restorable timestamp for the given mongodb collection in given region.

az cosmosdb mongodb retrieve-latest-backup-time --account-name
                                                --collection-name
                                                --database-name
                                                --location
                                                --resource-group

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--collection-name -c

Name of the CosmosDB MongoDB collection name.

--database-name -d

Name of the CosmosDB MongoDB database name.

--location -l

Location of the account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.