Microsoft.DocumentDB mongoClusters
Bicep resource definition
The mongoClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-10-01-preview' = {
location: 'string'
name: 'string'
properties: {
administrator: {
password: 'string'
userName: 'string'
}
backup: {}
compute: {
tier: 'string'
}
createMode: 'string'
dataApi: {
mode: 'string'
}
highAvailability: {
targetMode: 'string'
}
previewFeatures: [
'string'
]
publicNetworkAccess: 'string'
replicaParameters: {
sourceLocation: 'string'
sourceResourceId: 'string'
}
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
sharding: {
shardCount: int
}
storage: {
sizeGb: int
}
}
tags: {
{customized property}: 'string'
}
}
Property values
AdministratorProperties
| Name | Description | Value |
|---|---|---|
| password | The administrator password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| userName | The administrator user name. | string |
BackupProperties
| Name | Description | Value |
|---|
ComputeProperties
| Name | Description | Value |
|---|---|---|
| tier | The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. | string |
DataApiProperties
| Name | Description | Value |
|---|---|---|
| mode | The mode to indicate whether the Mongo Data API is enabled for a cluster. | 'Disabled' 'Enabled' |
HighAvailabilityProperties
| Name | Description | Value |
|---|---|---|
| targetMode | The target high availability mode requested for the cluster. | 'Disabled' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required) |
| properties | The resource-specific properties for this resource. | MongoClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
MongoClusterProperties
| Name | Description | Value |
|---|---|---|
| administrator | The local administrator properties for the mongo cluster. | AdministratorProperties |
| backup | The backup properties of the mongo cluster. | BackupProperties |
| compute | The compute properties of the mongo cluster. | ComputeProperties |
| createMode | The mode to create a mongo cluster. | 'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica' |
| dataApi | The Data API properties of the mongo cluster. | DataApiProperties |
| highAvailability | The high availability properties of the mongo cluster. | HighAvailabilityProperties |
| previewFeatures | List of private endpoint connections. | String array containing any of: 'GeoReplicas' |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this mongo cluster. | 'Disabled' 'Enabled' |
| replicaParameters | The parameters to create a replica mongo cluster. | MongoClusterReplicaParameters |
| restoreParameters | The parameters to create a point-in-time restore mongo cluster. | MongoClusterRestoreParameters |
| serverVersion | The Mongo DB server version. Defaults to the latest available version if not specified. | string |
| sharding | The sharding properties of the mongo cluster. | ShardingProperties |
| storage | The storage properties of the mongo cluster. | StorageProperties |
MongoClusterReplicaParameters
| Name | Description | Value |
|---|---|---|
| sourceLocation | The location of the source cluster | string (required) |
| sourceResourceId | The id of the replication source cluster. | string (required) |
MongoClusterRestoreParameters
| Name | Description | Value |
|---|---|---|
| pointInTimeUTC | UTC point in time to restore a mongo cluster | string |
| sourceResourceId | Resource ID to locate the source cluster to restore | string |
ShardingProperties
| Name | Description | Value |
|---|---|---|
| shardCount | Number of shards to provision on the cluster. | int |
StorageProperties
| Name | Description | Value |
|---|---|---|
| sizeGb | The size of the data disk assigned to each server. | int |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The mongoClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2024-10-01-preview",
"name": "string",
"location": "string",
"properties": {
"administrator": {
"password": "string",
"userName": "string"
},
"backup": {
},
"compute": {
"tier": "string"
},
"createMode": "string",
"dataApi": {
"mode": "string"
},
"highAvailability": {
"targetMode": "string"
},
"previewFeatures": [ "string" ],
"publicNetworkAccess": "string",
"replicaParameters": {
"sourceLocation": "string",
"sourceResourceId": "string"
},
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string",
"sharding": {
"shardCount": "int"
},
"storage": {
"sizeGb": "int"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
AdministratorProperties
| Name | Description | Value |
|---|---|---|
| password | The administrator password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| userName | The administrator user name. | string |
BackupProperties
| Name | Description | Value |
|---|
ComputeProperties
| Name | Description | Value |
|---|---|---|
| tier | The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. | string |
DataApiProperties
| Name | Description | Value |
|---|---|---|
| mode | The mode to indicate whether the Mongo Data API is enabled for a cluster. | 'Disabled' 'Enabled' |
HighAvailabilityProperties
| Name | Description | Value |
|---|---|---|
| targetMode | The target high availability mode requested for the cluster. | 'Disabled' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-10-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required) |
| properties | The resource-specific properties for this resource. | MongoClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DocumentDB/mongoClusters' |
MongoClusterProperties
| Name | Description | Value |
|---|---|---|
| administrator | The local administrator properties for the mongo cluster. | AdministratorProperties |
| backup | The backup properties of the mongo cluster. | BackupProperties |
| compute | The compute properties of the mongo cluster. | ComputeProperties |
| createMode | The mode to create a mongo cluster. | 'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica' |
| dataApi | The Data API properties of the mongo cluster. | DataApiProperties |
| highAvailability | The high availability properties of the mongo cluster. | HighAvailabilityProperties |
| previewFeatures | List of private endpoint connections. | String array containing any of: 'GeoReplicas' |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this mongo cluster. | 'Disabled' 'Enabled' |
| replicaParameters | The parameters to create a replica mongo cluster. | MongoClusterReplicaParameters |
| restoreParameters | The parameters to create a point-in-time restore mongo cluster. | MongoClusterRestoreParameters |
| serverVersion | The Mongo DB server version. Defaults to the latest available version if not specified. | string |
| sharding | The sharding properties of the mongo cluster. | ShardingProperties |
| storage | The storage properties of the mongo cluster. | StorageProperties |
MongoClusterReplicaParameters
| Name | Description | Value |
|---|---|---|
| sourceLocation | The location of the source cluster | string (required) |
| sourceResourceId | The id of the replication source cluster. | string (required) |
MongoClusterRestoreParameters
| Name | Description | Value |
|---|---|---|
| pointInTimeUTC | UTC point in time to restore a mongo cluster | string |
| sourceResourceId | Resource ID to locate the source cluster to restore | string |
ShardingProperties
| Name | Description | Value |
|---|---|---|
| shardCount | Number of shards to provision on the cluster. | int |
StorageProperties
| Name | Description | Value |
|---|---|---|
| sizeGb | The size of the data disk assigned to each server. | int |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The mongoClusters resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administrator = {
password = "string"
userName = "string"
}
backup = {
}
compute = {
tier = "string"
}
createMode = "string"
dataApi = {
mode = "string"
}
highAvailability = {
targetMode = "string"
}
previewFeatures = [
"string"
]
publicNetworkAccess = "string"
replicaParameters = {
sourceLocation = "string"
sourceResourceId = "string"
}
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
sharding = {
shardCount = int
}
storage = {
sizeGb = int
}
}
})
}
Property values
AdministratorProperties
| Name | Description | Value |
|---|---|---|
| password | The administrator password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| userName | The administrator user name. | string |
BackupProperties
| Name | Description | Value |
|---|
ComputeProperties
| Name | Description | Value |
|---|---|---|
| tier | The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. | string |
DataApiProperties
| Name | Description | Value |
|---|---|---|
| mode | The mode to indicate whether the Mongo Data API is enabled for a cluster. | 'Disabled' 'Enabled' |
HighAvailabilityProperties
| Name | Description | Value |
|---|---|---|
| targetMode | The target high availability mode requested for the cluster. | 'Disabled' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (required) |
| properties | The resource-specific properties for this resource. | MongoClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview" |
MongoClusterProperties
| Name | Description | Value |
|---|---|---|
| administrator | The local administrator properties for the mongo cluster. | AdministratorProperties |
| backup | The backup properties of the mongo cluster. | BackupProperties |
| compute | The compute properties of the mongo cluster. | ComputeProperties |
| createMode | The mode to create a mongo cluster. | 'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica' |
| dataApi | The Data API properties of the mongo cluster. | DataApiProperties |
| highAvailability | The high availability properties of the mongo cluster. | HighAvailabilityProperties |
| previewFeatures | List of private endpoint connections. | String array containing any of: 'GeoReplicas' |
| publicNetworkAccess | Whether or not public endpoint access is allowed for this mongo cluster. | 'Disabled' 'Enabled' |
| replicaParameters | The parameters to create a replica mongo cluster. | MongoClusterReplicaParameters |
| restoreParameters | The parameters to create a point-in-time restore mongo cluster. | MongoClusterRestoreParameters |
| serverVersion | The Mongo DB server version. Defaults to the latest available version if not specified. | string |
| sharding | The sharding properties of the mongo cluster. | ShardingProperties |
| storage | The storage properties of the mongo cluster. | StorageProperties |
MongoClusterReplicaParameters
| Name | Description | Value |
|---|---|---|
| sourceLocation | The location of the source cluster | string (required) |
| sourceResourceId | The id of the replication source cluster. | string (required) |
MongoClusterRestoreParameters
| Name | Description | Value |
|---|---|---|
| pointInTimeUTC | UTC point in time to restore a mongo cluster | string |
| sourceResourceId | Resource ID to locate the source cluster to restore | string |
ShardingProperties
| Name | Description | Value |
|---|---|---|
| shardCount | Number of shards to provision on the cluster. | int |
StorageProperties
| Name | Description | Value |
|---|---|---|
| sizeGb | The size of the data disk assigned to each server. | int |
TrackedResourceTags
| Name | Description | Value |
|---|