az documentdb
Note
This reference is part of the documentdb extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az documentdb command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage Azure DocumentDB clusters.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az documentdb mongocluster |
Manage Azure DocumentDB mongo clusters. |
Extension | Preview |
| az documentdb mongocluster check-name-availability |
Check if mongo cluster name is available for use. |
Extension | Preview |
| az documentdb mongocluster create |
Create a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH. |
Extension | Preview |
| az documentdb mongocluster delete |
Delete a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster firewall-rule |
Manage Firewall Rule. |
Extension | Preview |
| az documentdb mongocluster firewall-rule create |
Create a new firewall rule or updates an existing firewall rule on a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster firewall-rule delete |
Delete a mongo cluster firewall rule. |
Extension | Preview |
| az documentdb mongocluster firewall-rule list |
List all the firewall rules in a given mongo cluster. |
Extension | Preview |
| az documentdb mongocluster firewall-rule show |
Get information about a mongo cluster firewall rule. |
Extension | Preview |
| az documentdb mongocluster firewall-rule update |
Update a new firewall rule or updates an existing firewall rule on a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster firewall-rule wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az documentdb mongocluster identity |
Manage Identity. |
Extension | Preview |
| az documentdb mongocluster identity assign |
Assign the user or system managed identities. |
Extension | Preview |
| az documentdb mongocluster identity list |
List the managed identities assigned to a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster identity remove |
Remove the user or system managed identities. |
Extension | Preview |
| az documentdb mongocluster identity show |
Show the details of managed identities. |
Extension | Preview |
| az documentdb mongocluster identity wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az documentdb mongocluster list |
List all the mongo clusters in a given subscription. |
Extension | Preview |
| az documentdb mongocluster list-connection-strings |
List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster. |
Extension | Preview |
| az documentdb mongocluster microsoft-entra-user |
Manage Microsoft Entra ID users on a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster microsoft-entra-user assign |
Grant a Microsoft Entra ID principal access to a mongo cluster by assigning it database roles. |
Extension | Preview |
| az documentdb mongocluster microsoft-entra-user list |
List the Microsoft Entra ID users on a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster microsoft-entra-user remove |
Remove a Microsoft Entra ID principal's access from a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster microsoft-entra-user show |
Get the definition of a Microsoft Entra ID user on a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster microsoft-entra-user wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
| az documentdb mongocluster replica |
Manage Replica. |
Extension | Preview |
| az documentdb mongocluster replica create |
Create a read replica of an existing mongo cluster. |
Extension | Preview |
| az documentdb mongocluster replica list |
List all the replicas for the mongo cluster. |
Extension | Preview |
| az documentdb mongocluster replica promote |
Promotes a replica mongo cluster to a primary role. |
Extension | Preview |
| az documentdb mongocluster reset-password |
Reset the administrator password of a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster restore |
Restore a mongo cluster to a new cluster from a point in time. |
Extension | Preview |
| az documentdb mongocluster show |
Get information about a mongo cluster. |
Extension | Preview |
| az documentdb mongocluster update |
Update a mongo cluster. Only the properties specified in the request are modified; all other properties are left unchanged (HTTP PATCH). Generic update arguments (--set, --add, --remove) are supported. |
Extension | Preview |
| az documentdb mongocluster wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
