Microsoft.DocumentDB (preview:2025-04-01)

2025/06/02 • 6 updated methods

MongoClusters_List (updated)
Description :  List all the mongo clusters in a given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MongoClusters_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "authConfig": [
                  {
                    "allowedModes": {
                      "Enum": {
                        "new": [
                          [
                            "NativeAuth",
                            "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                          ],
                          [
                            "MicrosoftEntraID",
                            "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                          ]
                        ],
                        "old": [
                          [
                            "NativeAuth",
                            "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                          ],
                          [
                            "MicrosoftEntraID",
                            "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                          ]
                        ]
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MongoCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MongoClusters_ListByResourceGroup (updated)
Description :  List all the mongo clusters in a given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MongoClusters_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "authConfig": [
                  {
                    "allowedModes": {
                      "Enum": {
                        "new": [
                          [
                            "NativeAuth",
                            "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                          ],
                          [
                            "MicrosoftEntraID",
                            "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                          ]
                        ],
                        "old": [
                          [
                            "NativeAuth",
                            "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                          ],
                          [
                            "MicrosoftEntraID",
                            "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                          ]
                        ]
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MongoCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MongoClusters_Get (updated)
Description :  Gets information about a mongo cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MongoClusters_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authConfig": [
              {
                "allowedModes": {
                  "Enum": {
                    "new": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ],
                    "old": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mongoClusterName:
{
Description: The name of the mongo cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MongoClusters_CreateOrUpdate (updated)
Description :  Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MongoClusters_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "authConfig": [
              {
                "allowedModes": {
                  "Enum": {
                    "new": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ],
                    "old": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authConfig": [
              {
                "allowedModes": {
                  "Enum": {
                    "new": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ],
                    "old": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "authConfig": [
              {
                "allowedModes": {
                  "Enum": {
                    "new": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ],
                    "old": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mongoClusterName:
{
Description: The name of the mongo cluster. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents a mongo cluster resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MongoClusters_Update (updated)
Description :  Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MongoClusters_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "authConfig": [
              {
                "allowedModes": {
                  "Enum": {
                    "new": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ],
                    "old": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authConfig": [
              {
                "allowedModes": {
                  "Enum": {
                    "new": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ],
                    "old": [
                      [
                        "NativeAuth",
                        "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                      ],
                      [
                        "MicrosoftEntraID",
                        "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                      ]
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mongoClusterName:
{
Description: The name of the mongo cluster. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Replicas_ListByParent (updated)
Description :  List all the replicas for the mongo cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_ListByParent",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "authConfig": [
                  {
                    "allowedModes": {
                      "Enum": {
                        "new": [
                          [
                            "NativeAuth",
                            "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                          ],
                          [
                            "MicrosoftEntraID",
                            "Microsoft Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                          ]
                        ],
                        "old": [
                          [
                            "NativeAuth",
                            "Native mongo authentication mode using username and password with auth mechanism 'SCRAM-SHA-256'."
                          ],
                          [
                            "MicrosoftEntraID",
                            "Microsot Entra ID authentication mode using Entra users assigned to the cluster and auth mechanism 'MONGODB-OIDC'."
                          ]
                        ]
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}/replicas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
mongoClusterName:
{
Description: The name of the mongo cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Replica items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
createMode:
{
Description: The mode to create a mongo cluster. ,
Enum:
{
Default: Create a new mongo cluster. ,
PointInTimeRestore: Create a mongo cluster from a restore point-in-time. ,
GeoReplica: Create a replica cluster in distinct geographic region from the source cluster. ,
Replica: Create a replica cluster in the same geographic region as the source cluster. ,
}
,
Required: False ,
}
enum ,
restoreParameters:
{
Description: The parameters to create a point-in-time restore mongo cluster. ,
Required: False ,
}
{
pointInTimeUTC:
{
Description: UTC point in time to restore a mongo cluster ,
Format: date-time ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: Resource ID to locate the source cluster to restore ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicaParameters:
{
Description: The parameters to create a replica mongo cluster. ,
Required: False ,
}
{
sourceResourceId:
{
Description: The id of the replication source cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceLocation:
{
Description: The location of the source cluster ,
Required: True ,
}
string ,
}
,
administrator:
{
Description: The local administrator properties for the mongo cluster. ,
Required: False ,
}
{
userName:
{
Description: The administrator user name. ,
Required: False ,
}
string ,
password:
{
Description: The administrator password. ,
Format: password ,
Required: False ,
}
string ,
}
,
serverVersion:
{
Description: The Mongo DB server version. Defaults to the latest available version if not specified. ,
Required: False ,
}
string ,
connectionString:
{
Description: The default mongo connection string for the cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the mongo cluster. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
InProgress: An operation is in-progress on the resource. ,
Updating: An update operation is in-progress on the resource. ,
Dropping: A drop operation is in-progress on the resource. ,
}
,
Required: False ,
}
enum ,
clusterStatus:
{
Description: The status of the mongo cluster. ,
Enum:
{
Ready: The mongo cluster resource is ready for use. ,
Provisioning: The mongo cluster resource is being provisioned. ,
Updating: The mongo cluster resource is being updated. ,
Starting: The mongo cluster resource is being started. ,
Stopping: The mongo cluster resource is being stopped. ,
Stopped: The mongo cluster resource is stopped. ,
Dropping: The mongo cluster resource is being dropped. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this mongo cluster. ,
Enum:
{
Enabled: If set, mongo cluster can be accessed through private and public methods. ,
Disabled: If set, the private endpoints are the exclusive access method. ,
}
,
Required: False ,
}
enum ,
highAvailability:
{
Description: The high availability properties of the mongo cluster. ,
Required: False ,
}
{
targetMode:
{
Description: The target high availability mode requested for the cluster. ,
Enum:
{
Disabled: High availability mode is disabled. This mode is can see availability impact during faults or maintenance and is not recommended for production. ,
SameZone: High availability mode is enabled, where each server in a shard is placed in the same availability zone. ,
ZoneRedundantPreferred: High availability mode is enabled and preferences ZoneRedundant if availability zones capacity is available in the region, otherwise falls-back to provisioning with SameZone. ,
}
,
Required: False ,
}
enum ,
}
,
storage:
{
Description: The storage properties of the mongo cluster. ,
Required: False ,
}
{
sizeGb:
{
Description: The size of the data disk assigned to each server. ,
Format: int64 ,
Required: False ,
}
integer ,
type:
{
Description: The type of storage to provision the cluster servers with. ,
Enum:
{
PremiumSSD: Premium SSD for high performance workloads. ,
PremiumSSDv2: Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional limitations. ,
}
,
Required: False ,
}
enum ,
iops:
{
Description: The IOPs of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
throughput:
{
Description: The throughput of the storage assigned to each server. Only applicable if the type is 'PremiumSSDv2'. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sharding:
{
Description: The sharding properties of the mongo cluster. ,
Required: False ,
}
{
shardCount:
{
Description: Number of shards to provision on the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
compute:
{
Description: The compute properties of the mongo cluster. ,
Required: False ,
}
{
tier:
{
Description: The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. ,
Required: False ,
}
string ,
}
,
backup:
{
Description: The backup properties of the mongo cluster. ,
Required: False ,
}
{
earliestRestoreTime:
{
Description: Earliest restore timestamp in UTC ISO8601 format. ,
Required: False ,
}
string ,
}
,
dataApi:
{
Description: The Data API properties of the mongo cluster. ,
Required: False ,
}
{
mode:
{
Description: The mode to indicate whether the Mongo Data API is enabled for a cluster. ,
Enum:
{
Enabled: Mongo Data API is enabled for the cluster. ,
Disabled: Mongo Data API is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
previewFeatures:
{
Description: List of private endpoint connections. ,
Required: False ,
}
[
string ,
]
,
replica:
{
Description: The replication properties for the mongo cluster ,
Required: False ,
}
{
sourceResourceId:
{
Description: The resource id the source cluster for the replica cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
role:
{
Description: The replication role of the cluster ,
Enum:
{
Primary: The cluster is a primary replica. ,
AsyncReplica: The cluster is a local asynchronous replica. ,
GeoAsyncReplica: The cluster is a geo-asynchronous replica. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: The replication link state of the replica cluster. ,
Enum:
{
Active: Replication link is active. ,
Catchup: Replica is catching-up with the primary. This can occur after the replica is created or after a promotion is triggered. ,
Provisioning: Replica and replication link to the primary is being created. ,
Updating: Replication link is being updated due to a change on the replica or an upgrade. ,
Broken: Replication link is broken and the replica may need to be recreated. ,
Reconfiguring: Replication link is re-configuring due to a promotion event. ,
}
,
Required: False ,
}
enum ,
}
,
infrastructureVersion:
{
Description: The infrastructure version the cluster is provisioned on. ,
Required: False ,
}
string ,
authConfig:
{
Description: The authentication configuration for the cluster. ,
Required: False ,
}
{
allowedModes:
{
Description: Allowed authentication modes for data access on the cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}