Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/_check-name-availability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster check-name-availability_

Check if mongo cluster name is available for use.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL2xvY2F0aW9ucy97fS9jaGVja21vbmdvY2x1c3Rlcm5hbWVhdmFpbGFiaWxpdHk=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.documentdb/locations/{}/checkmongoclusternameavailability 2026-06-01 -->

#### examples

- Check if a mongo cluster name is available.
```bash
documentdb mongocluster check-name-availability --location eastus --name MyCluster
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster create_

Create a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 -->

#### examples

- Create a mongo cluster with Premium SSD v2 storage.
```bash
documentdb mongocluster create -n MyCluster -g MyResourceGroup --location eastus --admin-user dbadmin --admin-password MyP@ssw0rd123! --tier M30 --storage-size 128 --storage-type PremiumSSDv2 --shard-count 1 --high-availability Disabled
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster delete_

Delete a mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 -->

#### examples

- Delete a mongo cluster.
```bash
documentdb mongocluster delete -n MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/_list-connection-strings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _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.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vbGlzdGNvbm5lY3Rpb25zdHJpbmdz/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/listconnectionstrings 2026-06-01 -->

#### examples

- List the connection strings for a mongo cluster.
```bash
documentdb mongocluster list-connection-strings --cluster-name MyCluster -g MyResourceGroup
```
17 changes: 17 additions & 0 deletions Commands/documentdb/mongocluster/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Command] _documentdb mongocluster list_

List all the mongo clusters in a given subscription.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnM=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.documentdb/mongoclusters 2026-06-01 -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters 2026-06-01 -->

#### examples

- List all mongo clusters in a resource group.
```bash
documentdb mongocluster list -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster show_

Get information about a mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 -->

#### examples

- Get information about a mongo cluster.
```bash
documentdb mongocluster show -n MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster update_

Update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 -->

#### examples

- Update a mongo cluster's compute tier.
```bash
documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster firewall-rule create_

Create a new firewall rule or updates an existing firewall rule on a mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/firewallrules/{} 2026-06-01 -->

#### examples

- Create a firewall rule.
```bash
documentdb mongocluster firewall-rule create -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --start-ip-address 1.2.3.4 --end-ip-address 1.2.3.9
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster firewall-rule delete_

Delete a mongo cluster firewall rule.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/firewallrules/{} 2026-06-01 -->

#### examples

- Delete a firewall rule.
```bash
documentdb mongocluster firewall-rule delete -n AllowOffice --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster firewall-rule list_

List all the firewall rules in a given mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcw==/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/firewallrules 2026-06-01 -->

#### examples

- List firewall rules on a cluster.
```bash
documentdb mongocluster firewall-rule list --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster firewall-rule show_

Get information about a mongo cluster firewall rule.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/firewallrules/{} 2026-06-01 -->

#### examples

- Get a firewall rule.
```bash
documentdb mongocluster firewall-rule show -n AllowOffice --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster firewall-rule update_

Update a new firewall rule or updates an existing firewall rule on a mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/firewallrules/{} 2026-06-01 -->

#### examples

- Update a firewall rule's IP range.
```bash
documentdb mongocluster firewall-rule update -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --end-ip-address 1.2.3.20
```
20 changes: 20 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _documentdb mongocluster firewall-rule_

Manage Firewall Rule

## Commands

- [create](/Commands/documentdb/mongocluster/firewall-rule/_create.md)
: Create a new firewall rule or updates an existing firewall rule on a mongo cluster.

- [delete](/Commands/documentdb/mongocluster/firewall-rule/_delete.md)
: Delete a mongo cluster firewall rule.

- [list](/Commands/documentdb/mongocluster/firewall-rule/_list.md)
: List all the firewall rules in a given mongo cluster.

- [show](/Commands/documentdb/mongocluster/firewall-rule/_show.md)
: Get information about a mongo cluster firewall rule.

- [update](/Commands/documentdb/mongocluster/firewall-rule/_update.md)
: Update a new firewall rule or updates an existing firewall rule on a mongo cluster.
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/identity/_assign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster identity assign_

Assign the user or system managed identities.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 identity -->

#### examples

- Assign a user-assigned managed identity.
```bash
documentdb mongocluster identity assign -n MyCluster -g MyResourceGroup --user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/identity/_remove.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster identity remove_

Remove the user or system managed identities.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 identity -->

#### examples

- Remove a managed identity.
```bash
documentdb mongocluster identity remove -n MyCluster -g MyResourceGroup --user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/identity/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster identity show_

Show the details of managed identities.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-01 identity -->

#### examples

- Show managed identities.
```bash
documentdb mongocluster identity show -n MyCluster -g MyResourceGroup
```
14 changes: 14 additions & 0 deletions Commands/documentdb/mongocluster/identity/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# [Group] _documentdb mongocluster identity_

Manage Identity

## Commands

- [assign](/Commands/documentdb/mongocluster/identity/_assign.md)
: Assign the user or system managed identities.

- [remove](/Commands/documentdb/mongocluster/identity/_remove.md)
: Remove the user or system managed identities.

- [show](/Commands/documentdb/mongocluster/identity/_show.md)
: Show the details of managed identities.
40 changes: 40 additions & 0 deletions Commands/documentdb/mongocluster/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# [Group] _documentdb mongocluster_

Manage Mongo Cluster

## Subgroups

- [firewall-rule](/Commands/documentdb/mongocluster/firewall-rule/readme.md)
: Manage Firewall Rule

- [identity](/Commands/documentdb/mongocluster/identity/readme.md)
: Manage Identity

- [replica](/Commands/documentdb/mongocluster/replica/readme.md)
: Manage Replica

- [user](/Commands/documentdb/mongocluster/user/readme.md)
: Manage User

## Commands

- [check-name-availability](/Commands/documentdb/mongocluster/_check-name-availability.md)
: Check if mongo cluster name is available for use.

- [create](/Commands/documentdb/mongocluster/_create.md)
: Create a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.

- [delete](/Commands/documentdb/mongocluster/_delete.md)
: Delete a mongo cluster.

- [list](/Commands/documentdb/mongocluster/_list.md)
: List all the mongo clusters in a given subscription.

- [list-connection-strings](/Commands/documentdb/mongocluster/_list-connection-strings.md)
: 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.

- [show](/Commands/documentdb/mongocluster/_show.md)
: Get information about a mongo cluster.

- [update](/Commands/documentdb/mongocluster/_update.md)
: Update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/replica/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster replica list_

List all the replicas for the mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vcmVwbGljYXM=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/replicas 2026-06-01 -->

#### examples

- List replicas of a cluster.
```bash
documentdb mongocluster replica list --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/replica/_promote.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster replica promote_

Promotes a replica mongo cluster to a primary role.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vcHJvbW90ZQ==/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/promote 2026-06-01 -->

#### examples

- Promote a replica to primary.
```bash
documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/replica/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _documentdb mongocluster replica_

Manage Replica

## Commands

- [list](/Commands/documentdb/mongocluster/replica/_list.md)
: List all the replicas for the mongo cluster.

- [promote](/Commands/documentdb/mongocluster/replica/_promote.md)
: Promotes a replica mongo cluster to a primary role.
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/user/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster user create_

Create a new user or updates an existing user on a mongo cluster.

## Versions

### [2026-06-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vdXNlcnMve30=/2026-06-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{}/users/{} 2026-06-01 -->

#### examples

- Create an Entra-backed user.
```bash
documentdb mongocluster user create -n alice-entra --cluster-name MyCluster -g MyResourceGroup --type User --role db=admin role=root
```
Loading
Loading