你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB mongoClusters 2024-10-01-preview

项目
12/20/2024

Bicep 资源定义

可以使用目标操作部署 mongoClusters 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DocumentDB/mongoClusters 资源，请将以下 Bicep 添加到模板。

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'
  }
}

属性值

AdministratorProperties

名字	描述	价值
密码	管理员密码。	字符串约束：敏感值。以安全参数的形式传入。
userName	管理员用户名。	字符串

BackupProperties

名字	描述	价值

ComputeProperties

名字	描述	价值
层	要分配给群集的计算层，其中每个层映射到虚拟核心和内存大小。示例值：“M30”、“M40”。	字符串

DataApiProperties

名字	描述	价值
模式	指示是否为群集启用 Mongo 数据 API 的模式。	“Disabled” “Enabled”

HighAvailabilityProperties

名字	描述	价值
targetMode	为群集请求的目标高可用性模式。	“Disabled” “SameZone” “ZoneRedundantPreferred”

Microsoft.DocumentDB/mongoClusters

名字	描述	价值
位置	资源所在的地理位置	string （必需）
名字	资源名称	字符串约束：最小长度 = 3 最大长度 = 3 模式 = `^[a-z0-9]+(-[a-z0-9]+)*` （必需）
性能	此资源的资源特定属性。	MongoClusterProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

MongoClusterProperties

名字	描述	价值
管理员	mongo 群集的本地管理员属性。	AdministratorProperties
备份	mongo 群集的备份属性。	BackupProperties
计算	mongo 群集的计算属性。	ComputeProperties
createMode	用于创建 mongo 群集的模式。	“Default” “GeoReplica” “PointInTimeRestore” “Replica”
dataApi	mongo 群集的数据 API 属性。	DataApiProperties
highAvailability	mongo 群集的高可用性属性。	HighAvailabilityProperties
previewFeatures	专用终结点连接列表。	包含任一项的字符串数组： “GeoReplicas”
publicNetworkAccess	是否允许此 mongo 群集访问公共终结点。	“Disabled” “Enabled”
replicaParameters	用于创建副本 mongo 群集的参数。	MongoClusterReplicaParameters
restoreParameters	用于创建时间点还原 mongo 群集的参数。	MongoClusterRestoreParameters
serverVersion	Mongo DB 服务器版本。如果未指定，则默认为最新可用版本。	字符串
分片	mongo 群集的分片属性。	分片Properties
存储	mongo 群集的存储属性。	StorageProperties

MongoClusterReplicaParameters

名字	描述	价值
sourceLocation	源群集的位置	string （必需）
sourceResourceId	复制源群集的 ID。	string （必需）

MongoClusterRestoreParameters

名字	描述	价值
pointInTimeUTC	还原 Mongo 群集的 UTC 时间点	字符串
sourceResourceId	用于查找要还原的源群集的资源 ID	字符串

ShardingProperties

名字	描述	价值
shardCount	在群集上预配的分片数。	int

StorageProperties

名字	描述	价值
sizeGb	分配给每个服务器的数据磁盘的大小。	int

TrackedResourceTags

名字	描述	价值

ARM 模板资源定义

可以使用目标操作部署 mongoClusters 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DocumentDB/mongoClusters 资源，请将以下 JSON 添加到模板。

{
  "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"
  }
}

属性值

AdministratorProperties

名字	描述	价值
密码	管理员密码。	字符串约束：敏感值。以安全参数的形式传入。
userName	管理员用户名。	字符串

BackupProperties

名字	描述	价值

ComputeProperties

名字	描述	价值
层	要分配给群集的计算层，其中每个层映射到虚拟核心和内存大小。示例值：“M30”、“M40”。	字符串

DataApiProperties

名字	描述	价值
模式	指示是否为群集启用 Mongo 数据 API 的模式。	“Disabled” “Enabled”

HighAvailabilityProperties

名字	描述	价值
targetMode	为群集请求的目标高可用性模式。	“Disabled” “SameZone” “ZoneRedundantPreferred”

Microsoft.DocumentDB/mongoClusters

名字	描述	价值
apiVersion	API 版本	'2024-10-01-preview'
位置	资源所在的地理位置	string （必需）
名字	资源名称	字符串约束：最小长度 = 3 最大长度 = 3 模式 = `^[a-z0-9]+(-[a-z0-9]+)*` （必需）
性能	此资源的资源特定属性。	MongoClusterProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.DocumentDB/mongoClusters”

MongoClusterProperties

名字	描述	价值
管理员	mongo 群集的本地管理员属性。	AdministratorProperties
备份	mongo 群集的备份属性。	BackupProperties
计算	mongo 群集的计算属性。	ComputeProperties
createMode	用于创建 mongo 群集的模式。	“Default” “GeoReplica” “PointInTimeRestore” “Replica”
dataApi	mongo 群集的数据 API 属性。	DataApiProperties
highAvailability	mongo 群集的高可用性属性。	HighAvailabilityProperties
previewFeatures	专用终结点连接列表。	包含任一项的字符串数组： “GeoReplicas”
publicNetworkAccess	是否允许此 mongo 群集访问公共终结点。	“Disabled” “Enabled”
replicaParameters	用于创建副本 mongo 群集的参数。	MongoClusterReplicaParameters
restoreParameters	用于创建时间点还原 mongo 群集的参数。	MongoClusterRestoreParameters
serverVersion	Mongo DB 服务器版本。如果未指定，则默认为最新可用版本。	字符串
分片	mongo 群集的分片属性。	分片Properties
存储	mongo 群集的存储属性。	StorageProperties

MongoClusterReplicaParameters

名字	描述	价值
sourceLocation	源群集的位置	string （必需）
sourceResourceId	复制源群集的 ID。	string （必需）

MongoClusterRestoreParameters

名字	描述	价值
pointInTimeUTC	还原 Mongo 群集的 UTC 时间点	字符串
sourceResourceId	用于查找要还原的源群集的资源 ID	字符串

ShardingProperties

名字	描述	价值
shardCount	在群集上预配的分片数。	int

StorageProperties

名字	描述	价值
sizeGb	分配给每个服务器的数据磁盘的大小。	int

TrackedResourceTags

名字	描述	价值

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 mongoClusters 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DocumentDB/mongoClusters 资源，请将以下 Terraform 添加到模板。

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
      }
    }
  })
}

属性值

AdministratorProperties

名字	描述	价值
密码	管理员密码。	字符串约束：敏感值。以安全参数的形式传入。
userName	管理员用户名。	字符串

BackupProperties

名字	描述	价值

ComputeProperties

名字	描述	价值
层	要分配给群集的计算层，其中每个层映射到虚拟核心和内存大小。示例值：“M30”、“M40”。	字符串

DataApiProperties

名字	描述	价值
模式	指示是否为群集启用 Mongo 数据 API 的模式。	“Disabled” “Enabled”

HighAvailabilityProperties

名字	描述	价值
targetMode	为群集请求的目标高可用性模式。	“Disabled” “SameZone” “ZoneRedundantPreferred”

Microsoft.DocumentDB/mongoClusters

名字	描述	价值
位置	资源所在的地理位置	string （必需）
名字	资源名称	字符串约束：最小长度 = 3 最大长度 = 3 模式 = `^[a-z0-9]+(-[a-z0-9]+)*` （必需）
性能	此资源的资源特定属性。	MongoClusterProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DocumentDB/mongoClusters@2024-10-01-preview”

MongoClusterProperties

名字	描述	价值
管理员	mongo 群集的本地管理员属性。	AdministratorProperties
备份	mongo 群集的备份属性。	BackupProperties
计算	mongo 群集的计算属性。	ComputeProperties
createMode	用于创建 mongo 群集的模式。	“Default” “GeoReplica” “PointInTimeRestore” “Replica”
dataApi	mongo 群集的数据 API 属性。	DataApiProperties
highAvailability	mongo 群集的高可用性属性。	HighAvailabilityProperties
previewFeatures	专用终结点连接列表。	包含任一项的字符串数组： “GeoReplicas”
publicNetworkAccess	是否允许此 mongo 群集访问公共终结点。	“Disabled” “Enabled”
replicaParameters	用于创建副本 mongo 群集的参数。	MongoClusterReplicaParameters
restoreParameters	用于创建时间点还原 mongo 群集的参数。	MongoClusterRestoreParameters
serverVersion	Mongo DB 服务器版本。如果未指定，则默认为最新可用版本。	字符串
分片	mongo 群集的分片属性。	分片Properties
存储	mongo 群集的存储属性。	StorageProperties

MongoClusterReplicaParameters

名字	描述	价值
sourceLocation	源群集的位置	string （必需）
sourceResourceId	复制源群集的 ID。	string （必需）

MongoClusterRestoreParameters

名字	描述	价值
pointInTimeUTC	还原 Mongo 群集的 UTC 时间点	字符串
sourceResourceId	用于查找要还原的源群集的资源 ID	字符串

ShardingProperties

名字	描述	价值
shardCount	在群集上预配的分片数。	int

StorageProperties

名字	描述	价值
sizeGb	分配给每个服务器的数据磁盘的大小。	int

TrackedResourceTags

名字	描述	价值

通过

Microsoft.DocumentDB mongoClusters 2024-10-01-preview

Bicep 资源定义

资源格式

属性值

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

ARM 模板资源定义

资源格式

属性值

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

AdministratorProperties

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

反馈

其他资源