通过

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

Microsoft.DocumentDB mongoClusters 2023-03-15-preview

  • 项目

Bicep 资源定义

mongoClusters 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

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

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

属性值

mongoClusters

名称 说明 值
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties mongo 群集的属性。 MongoClusterProperties

MongoClusterProperties

名称 说明 值
administratorLogin mongo 群集的管理员登录名。 字符串
administratorLoginPassword 管理员登录名的密码。 字符串

约束：
敏感值。 作为安全参数传入。
createMode 用于创建 mongo 群集的模式。 'Default'
“PointInTimeRestore”
“还原”
nodeGroupSpecs 群集中的节点组规格列表。 NodeGroupSpec[]

约束：
最小长度 = 1
restoreParameters 用于还原操作的参数 MongoClusterRestoreParameters
serverVersion Mongo DB 服务器版本。 如果未指定，则默认为最新的可用版本。 字符串

NodeGroupSpec

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

MongoClusterRestoreParameters

名称 说明 值
pointInTimeUTC 用于还原 mongo 群集的 UTC 时间点 字符串
sourceResourceId 用于查找要还原的源群集的资源 ID 字符串

ARM 模板资源定义

mongoClusters 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

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

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

属性值

mongoClusters

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/mongoClusters'
apiVersion 资源 API 版本 '2023-03-15-preview'
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties mongo 群集的属性。 MongoClusterProperties

MongoClusterProperties

名称 说明 值
administratorLogin mongo 群集的管理员登录名。 字符串
administratorLoginPassword 管理员登录名的密码。 字符串

约束：
敏感值。 作为安全参数传入。
createMode 用于创建 mongo 群集的模式。 'Default'
“PointInTimeRestore”
“还原”
nodeGroupSpecs 群集中的节点组规格列表。 NodeGroupSpec[]

约束：
最小长度 = 1
restoreParameters 用于还原操作的参数 MongoClusterRestoreParameters
serverVersion Mongo DB 服务器版本。 如果未指定，则默认为最新的可用版本。 字符串

NodeGroupSpec

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

MongoClusterRestoreParameters

名称 说明 值
pointInTimeUTC 用于还原 mongo 群集的 UTC 时间点 字符串
sourceResourceId 用于查找要还原的源群集的资源 ID 字符串

Terraform (AzAPI 提供程序) 资源定义

mongoClusters 资源类型可以使用面向以下对象的操作进行部署：

  • 资源组

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

资源格式

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

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

属性值

mongoClusters

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/mongoClusters@2023-03-15-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
properties mongo 群集的属性。 MongoClusterProperties

MongoClusterProperties

名称 说明 值
administratorLogin mongo 群集的管理员登录名。 字符串
administratorLoginPassword 管理员登录名的密码。 字符串

约束：
敏感值。 作为安全参数传入。
createMode 用于创建 mongo 群集的模式。 “Default”
“PointInTimeRestore”
“还原”
nodeGroupSpecs 群集中的节点组规格列表。 NodeGroupSpec[]

约束：
最小长度 = 1
restoreParameters 用于还原操作的参数 MongoClusterRestoreParameters
serverVersion Mongo DB 服务器版本。 如果未指定，则默认为最新的可用版本。 字符串

NodeGroupSpec

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

MongoClusterRestoreParameters

名称 说明 值
pointInTimeUTC 用于还原 mongo 群集的 UTC 时间点 字符串
sourceResourceId 用于查找要还原的源群集的资源 ID 字符串