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
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/_check-name-availability.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Check if mongo cluster name is available for use.
```bash
documentdb mongocluster check-name-availability --location eastus --name MyCluster
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL2xvY2F0aW9ucy97fS9jaGVja21vbmdvY2x1c3Rlcm5hbWVhdmFpbGFiaWxpdHk=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Check if a mongo cluster name is available.
```bash
documentdb mongocluster check-name-availability --location eastus --name MyCluster
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Create a mongo cluster. Update overwrites all properties for the resource. To on
```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
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### 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
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Delete a mongo cluster.
```bash
documentdb mongocluster delete -n MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Delete a mongo cluster.
```bash
documentdb mongocluster delete -n MyCluster -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/_list-connection-strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ List mongo cluster connection strings. This includes the default connection stri
```bash
documentdb mongocluster list-connection-strings --cluster-name MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vbGlzdGNvbm5lY3Rpb25zdHJpbmdz/2026-06-15-preview.xml) **Preview**

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

#### examples

- List the connection strings for a mongo cluster.
```bash
documentdb mongocluster list-connection-strings --cluster-name MyCluster -g MyResourceGroup
```
12 changes: 12 additions & 0 deletions Commands/documentdb/mongocluster/_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,15 @@ List all the mongo clusters in a given subscription.
```bash
documentdb mongocluster list -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnM=/2026-06-15-preview.xml) **Preview**

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

#### examples

- List all mongo clusters in a resource group.
```bash
documentdb mongocluster list -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Get information about a mongo cluster.
```bash
documentdb mongocluster show -n MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Get information about a mongo cluster.
```bash
documentdb mongocluster show -n MyCluster -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Update a mongo cluster. Update overwrites all properties for the resource. To on
```bash
documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Update a mongo cluster's compute tier.
```bash
documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Create a new firewall rule or updates an existing firewall rule on a mongo clust
```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
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-15-preview.xml) **Preview**

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

#### 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
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Delete a mongo cluster firewall rule.
```bash
documentdb mongocluster firewall-rule delete -n AllowOffice --cluster-name MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-15-preview.xml) **Preview**

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

#### examples

- Delete a firewall rule.
```bash
documentdb mongocluster firewall-rule delete -n AllowOffice --cluster-name MyCluster -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ List all the firewall rules in a given mongo cluster.
```bash
documentdb mongocluster firewall-rule list --cluster-name MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcw==/2026-06-15-preview.xml) **Preview**

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

#### examples

- List firewall rules on a cluster.
```bash
documentdb mongocluster firewall-rule list --cluster-name MyCluster -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Get information about a mongo cluster firewall rule.
```bash
documentdb mongocluster firewall-rule show -n AllowOffice --cluster-name MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-15-preview.xml) **Preview**

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

#### examples

- Get a firewall rule.
```bash
documentdb mongocluster firewall-rule show -n AllowOffice --cluster-name MyCluster -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/firewall-rule/_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Update a new firewall rule or updates an existing firewall rule on a mongo clust
```bash
documentdb mongocluster firewall-rule update -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --end-ip-address 1.2.3.20
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vZmlyZXdhbGxydWxlcy97fQ==/2026-06-15-preview.xml) **Preview**

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

#### 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
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/identity/_assign.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Assign the user or system managed identities.
```bash
documentdb mongocluster identity assign -n MyCluster -g MyResourceGroup --user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-15-preview 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
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/identity/_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Remove the user or system managed identities.
```bash
documentdb mongocluster identity remove -n MyCluster -g MyResourceGroup --user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.documentdb/mongoclusters/{} 2026-06-15-preview 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
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/identity/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Show the details of managed identities.
```bash
documentdb mongocluster identity show -n MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Show managed identities.
```bash
documentdb mongocluster identity show -n MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/microsoft-entra-user/_assign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster microsoft-entra-user assign_

Grant a Microsoft Entra ID principal access to a mongo cluster by assigning it database roles.

## Versions

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vdXNlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Assign admin access to an Entra ID user (or service principal) by object ID.
```bash
documentdb mongocluster microsoft-entra-user assign --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup --type User --role db=admin role=root
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/microsoft-entra-user/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster microsoft-entra-user list_

List the Microsoft Entra ID users on a mongo cluster.

## Versions

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vdXNlcnM=/2026-06-15-preview.xml) **Preview**

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

#### examples

- List Entra ID users on a cluster.
```bash
documentdb mongocluster microsoft-entra-user list --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/microsoft-entra-user/_remove.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster microsoft-entra-user remove_

Remove a Microsoft Entra ID principal's access from a mongo cluster.

## Versions

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vdXNlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Remove an Entra ID user's access by object ID.
```bash
documentdb mongocluster microsoft-entra-user remove --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/microsoft-entra-user/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster microsoft-entra-user show_

Get the definition of a Microsoft Entra ID user on a mongo cluster.

## Versions

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vdXNlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Get an Entra ID user by object ID.
```bash
documentdb mongocluster microsoft-entra-user show --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/documentdb/mongocluster/microsoft-entra-user/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _documentdb mongocluster microsoft-entra-user update_

Update a Microsoft Entra ID user on a mongo cluster.

## Versions

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vdXNlcnMve30=/2026-06-15-preview.xml) **Preview**

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

#### examples

- Update an Entra ID user's roles.
```bash
documentdb mongocluster microsoft-entra-user update --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup --role db=admin role=root
```
20 changes: 20 additions & 0 deletions Commands/documentdb/mongocluster/microsoft-entra-user/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _documentdb mongocluster microsoft-entra-user_

Manage Microsoft Entra ID users on a mongo cluster.

## Commands

- [assign](/Commands/documentdb/mongocluster/microsoft-entra-user/_assign.md)
: Grant a Microsoft Entra ID principal access to a mongo cluster by assigning it database roles.

- [list](/Commands/documentdb/mongocluster/microsoft-entra-user/_list.md)
: List the Microsoft Entra ID users on a mongo cluster.

- [remove](/Commands/documentdb/mongocluster/microsoft-entra-user/_remove.md)
: Remove a Microsoft Entra ID principal's access from a mongo cluster.

- [show](/Commands/documentdb/mongocluster/microsoft-entra-user/_show.md)
: Get the definition of a Microsoft Entra ID user on a mongo cluster.

- [update](/Commands/documentdb/mongocluster/microsoft-entra-user/_update.md)
: Update a Microsoft Entra ID user on a mongo cluster.
5 changes: 4 additions & 1 deletion Commands/documentdb/mongocluster/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [Group] _documentdb mongocluster_

Manage Mongo Cluster
Manage Azure DocumentDB mongo clusters.

## Subgroups

Expand All @@ -10,6 +10,9 @@ Manage Mongo Cluster
- [identity](/Commands/documentdb/mongocluster/identity/readme.md)
: Manage Identity

- [microsoft-entra-user](/Commands/documentdb/mongocluster/microsoft-entra-user/readme.md)
: Manage Microsoft Entra ID users on a mongo cluster.

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

Expand Down
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/replica/_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ List all the replicas for the mongo cluster.
```bash
documentdb mongocluster replica list --cluster-name MyCluster -g MyResourceGroup
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vcmVwbGljYXM=/2026-06-15-preview.xml) **Preview**

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

#### examples

- List replicas of a cluster.
```bash
documentdb mongocluster replica list --parent-cluster-name MyCluster -g MyResourceGroup
```
11 changes: 11 additions & 0 deletions Commands/documentdb/mongocluster/replica/_promote.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Promotes a replica mongo cluster to a primary role.
```bash
documentdb mongocluster replica promote -n MyReplica -g MyResourceGroup --mode Switchover --promote-option Forced
```

### [2026-06-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5kb2N1bWVudGRiL21vbmdvY2x1c3RlcnMve30vcHJvbW90ZQ==/2026-06-15-preview.xml) **Preview**

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

#### examples

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

Manage Document Db
Manage Azure DocumentDB clusters.

## Subgroups

- [mongocluster](/Commands/documentdb/mongocluster/readme.md)
: Manage Mongo Cluster
: Manage Azure DocumentDB mongo clusters.
2 changes: 1 addition & 1 deletion Commands/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
: Manage Dns Resolver

- [documentdb](/Commands/documentdb/readme.md)
: Manage Document Db
: Manage Azure DocumentDB clusters.

- [durabletask](/Commands/durabletask/readme.md)
: Commands to manage Durabletask schedulers and taskhubs
Expand Down
Loading
Loading