通过

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

Microsoft.DocumentDB mongoClusters 2023-11-15-preview

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-11-15-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'string'
        nodeCount: int
        sku: 'string'
      }
    ]
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.DocumentDB/mongoClusters

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需）
性能 Mongo 群集的属性。 MongoClusterProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

MongoClusterProperties

名字 描述 价值
administratorLogin Mongo 群集的管理员登录名。 字符串
administratorLoginPassword 管理员登录名的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。
createMode 用于创建 mongo 群集的模式。 “Default”
“PointInTimeRestore”
“还原”
nodeGroupSpecs 群集中的节点组规格列表。 NodeGroupSpec[]
restoreParameters 用于还原操作的参数 MongoClusterRestoreParameters
serverVersion Mongo DB 服务器版本。 如果未指定，则默认为最新可用版本。 字符串

MongoClusterRestoreParameters

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

NodeGroupSpec

名字 描述 价值
diskSizeGB 节点组的磁盘存储大小（以 GB 为单位）。 示例值：128、256、512、1024。 int
enableHa 是否在节点组中启用高可用性。 bool
类 节点组中部署的节点类型。 “分片”
nodeCount 节点组中的节点数。 int
sku 节点组的资源 SKU。 这定义了为每个节点预配的 CPU 和内存的大小。 示例值：“M30”、“M40”。 字符串

TrackedResourceTags

名字 描述 价值

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2023-11-15-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "string",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.DocumentDB/mongoClusters

名字 描述 价值
apiVersion API 版本 '2023-11-15-preview'
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需）
性能 Mongo 群集的属性。 MongoClusterProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.DocumentDB/mongoClusters”

MongoClusterProperties

名字 描述 价值
administratorLogin Mongo 群集的管理员登录名。 字符串
administratorLoginPassword 管理员登录名的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。
createMode 用于创建 mongo 群集的模式。 “Default”
“PointInTimeRestore”
“还原”
nodeGroupSpecs 群集中的节点组规格列表。 NodeGroupSpec[]
restoreParameters 用于还原操作的参数 MongoClusterRestoreParameters
serverVersion Mongo DB 服务器版本。 如果未指定，则默认为最新可用版本。 字符串

MongoClusterRestoreParameters

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

NodeGroupSpec

名字 描述 价值
diskSizeGB 节点组的磁盘存储大小（以 GB 为单位）。 示例值：128、256、512、1024。 int
enableHa 是否在节点组中启用高可用性。 bool
类 节点组中部署的节点类型。 “分片”
nodeCount 节点组中的节点数。 int
sku 节点组的资源 SKU。 这定义了为每个节点预配的 CPU 和内存的大小。 示例值：“M30”、“M40”。 字符串

TrackedResourceTags

名字 描述 价值

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2023-11-15-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "string"
          nodeCount = int
          sku = "string"
        }
      ]
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

属性值

Microsoft.DocumentDB/mongoClusters

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需）
性能 Mongo 群集的属性。 MongoClusterProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DocumentDB/mongoClusters@2023-11-15-preview”

MongoClusterProperties

名字 描述 价值
administratorLogin Mongo 群集的管理员登录名。 字符串
administratorLoginPassword 管理员登录名的密码。 字符串

约束：
敏感值。 以安全参数的形式传入。
createMode 用于创建 mongo 群集的模式。 “Default”
“PointInTimeRestore”
“还原”
nodeGroupSpecs 群集中的节点组规格列表。 NodeGroupSpec[]
restoreParameters 用于还原操作的参数 MongoClusterRestoreParameters
serverVersion Mongo DB 服务器版本。 如果未指定，则默认为最新可用版本。 字符串

MongoClusterRestoreParameters

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

NodeGroupSpec

名字 描述 价值
diskSizeGB 节点组的磁盘存储大小（以 GB 为单位）。 示例值：128、256、512、1024。 int
enableHa 是否在节点组中启用高可用性。 bool
类 节点组中部署的节点类型。 “分片”
nodeCount 节点组中的节点数。 int
sku 节点组的资源 SKU。 这定义了为每个节点预配的 CPU 和内存的大小。 示例值：“M30”、“M40”。 字符串

TrackedResourceTags

名字 描述 价值