az cosmosdb mongocluster
Note
This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb mongocluster command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Mongo cluster.
Name | Description | Type | Status |
---|---|---|---|
az cosmosdb mongocluster create |
Create a Mongo cluster. |
Extension | Preview |
az cosmosdb mongocluster delete |
Delete a Mongo Cluster Resource. |
Extension | Preview |
az cosmosdb mongocluster firewall |
Mongo cluster firewall. |
Extension | Preview |
az cosmosdb mongocluster firewall rule |
Mongo cluster firewall rule. |
Extension | Preview |
az cosmosdb mongocluster firewall rule create |
Create a Mongo cluster firewall rule. |
Extension | Preview |
az cosmosdb mongocluster firewall rule delete |
Delete a Mongo cluster firewall rule. |
Extension | Preview |
az cosmosdb mongocluster firewall rule list |
Lists firewall rule on a Mongo cluster. |
Extension | Preview |
az cosmosdb mongocluster firewall rule show |
Get a Mongo cluster firewall rule. |
Extension | Preview |
az cosmosdb mongocluster firewall rule update |
Create a Mongo cluster firewall rule. |
Extension | Preview |
az cosmosdb mongocluster list |
List a Mongo Cluster Resource. |
Extension | Preview |
az cosmosdb mongocluster show |
Get a Mongo Cluster Resource. |
Extension | Preview |
az cosmosdb mongocluster update |
Update a Mongo cluster. |
Extension | Preview |
Command group 'cosmosdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a Mongo cluster.
az cosmosdb mongocluster create --administrator-login
--administrator-login-password
--cluster-name
--location
--resource-group
--server-version
--shard-node-count
--shard-node-disk-size-gb
--shard-node-ha {false, true}
--shard-node-tier
[--tags]
Create a Mongo cluster.
az cosmosdb mongocluster create \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--location MyLocation \
--administrator-login MyAdminUser \
--administrator-login-password MyAdminPassword \
--server-version 5.0 \
--shard-node-tier "M30" \
--shard-node-ha true \
--shard-node-disk-size-gb 128 \
--shard-node-count 2
The initial administrator user to be configured when a cluster is created.
The initial administrator password to be configured when a cluster is created.
Name of the Cosmos DB Mongo Cluster.
Azure Location of the Cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The server version of the mongo cluster.
The node count for mongo cluster.
The node disk size for mongo cluster.
If enabled the cluster has HA.
The node tier for mongo cluster.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Command group 'cosmosdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete a Mongo Cluster Resource.
az cosmosdb mongocluster delete --cluster-name
--resource-group
[--yes]
Deletes a Mongo Cluster Resource. If the cluster does not exist a NoContent response is returned.
az cosmosdb mongocluster delete --cluster-name MyCluster --resource-group MyResourceGroup
Name of the Cosmos DB Mongo Cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Command group 'cosmosdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List a Mongo Cluster Resource.
az cosmosdb mongocluster list [--resource-group]
Lists Mongo Cluster Resource list in a resource group.
az cosmosdb mongocluster list --resource-group MyResourceGroup
Lists a Mongo Cluster Resource list in the subscription.
az cosmosdb mongocluster list
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Command group 'cosmosdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a Mongo Cluster Resource.
az cosmosdb mongocluster show --cluster-name
--resource-group
Gets a Mongo Cluster Resource. ProvisioningState tells the state of this cluster. If the cluster does not exist a NotFound response is returned.
az cosmosdb mongocluster show --cluster-name MyCluster --resource-group MyResourceGroup
Name of the Cosmos DB Mongo Cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Command group 'cosmosdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a Mongo cluster.
az cosmosdb mongocluster update --cluster-name
--resource-group
[--administrator-login]
[--administrator-login-password]
[--server-version]
[--shard-node-disk-size-gb]
[--shard-node-ha {false, true}]
[--shard-node-tier]
[--tags]
Update a Mongo cluster.
az cosmosdb mongocluster update \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--administrator-login MyAdminUser \
--administrator-login-password MyAdminPassword \
--server-version 5.0 \
--shard-node-tier "M30" \
--shard-node-ha true \
--shard-node-disk-size-gb 128
Name of the Cosmos DB Mongo Cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The initial administrator user to be configured when a cluster is created.
The initial administrator password to be configured when a cluster is created.
The server version of the mongo cluster.
The node disk size for mongo cluster.
If enabled the cluster has HA.
The node tier for mongo cluster.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: