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

Microsoft.DocumentDB mongoClusters/firewallRules

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/mongoClusters/firewallRules@2025-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    endIpAddress: 'string'
    startIpAddress: 'string'
  }
}

属性值

Microsoft.DocumentDB/mongoClusters/firewallRules

名字 描述 价值
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 80
模式 = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* （必需）
父级 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：mongoClusters
性能 此资源的资源特定属性。 FirewallRuleProperties

FirewallRuleProperties

名字 描述 价值
endIp地址 Mongo 群集防火墙规则的结束 IP 地址。 必须是 IPv4 格式。 字符串

约束：
模式 = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ （必需）
startIpAddress （启动 IpAddress） Mongo 群集防火墙规则的起始 IP 地址。 必须是 IPv4 格式。 字符串

约束：
模式 = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ （必需）

用法示例

Bicep 示例

部署 Azure Cosmos DB for MongoDB（vCore）防火墙规则的基本示例。

param resourceName string = 'acctest0001'
param location string = 'westus3'

resource mongoCluster 'Microsoft.DocumentDB/mongoClusters@2025-09-01' = {
  name: resourceName
  location: location
  properties: {
    authConfig: {
      allowedModes: [
        'MicrosoftEntraID'
      ]
    }
    compute: {
      tier: 'M40'
    }
    highAvailability: {
      targetMode: 'Disabled'
    }
    previewFeatures: [
      'ShardRebalancer'
    ]
    publicNetworkAccess: 'Enabled'
    serverVersion: '5.0'
    sharding: {
      shardCount: 1
    }
    storage: {
      sizeGb: 32
    }
  }
}

resource firewallRule 'Microsoft.DocumentDB/mongoClusters/firewallRules@2025-09-01' = {
  parent: mongoCluster
  name: resourceName
  properties: {
    endIpAddress: '0.0.0.0'
    startIpAddress: '0.0.0.0'
  }
}

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/mongoClusters/firewallRules",
  "apiVersion": "2025-09-01",
  "name": "string",
  "properties": {
    "endIpAddress": "string",
    "startIpAddress": "string"
  }
}

属性值

Microsoft.DocumentDB/mongoClusters/firewallRules

名字 描述 价值
apiVersion API 版本 '2025-09-01'
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 80
模式 = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* （必需）
性能 此资源的资源特定属性。 FirewallRuleProperties
类型 资源类型 “Microsoft.DocumentDB/mongoClusters/firewallRules”

FirewallRuleProperties

名字 描述 价值
endIp地址 Mongo 群集防火墙规则的结束 IP 地址。 必须是 IPv4 格式。 字符串

约束：
模式 = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ （必需）
startIpAddress （启动 IpAddress） Mongo 群集防火墙规则的起始 IP 地址。 必须是 IPv4 格式。 字符串

约束：
模式 = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ （必需）

用法示例

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters/firewallRules@2025-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      endIpAddress = "string"
      startIpAddress = "string"
    }
  }
}

属性值

Microsoft.DocumentDB/mongoClusters/firewallRules

名字 描述 价值
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 80
模式 = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：mongoClusters
性能 此资源的资源特定属性。 FirewallRuleProperties
类型 资源类型 “Microsoft.DocumentDB/mongoClusters/firewallRules@2025-09-01”

FirewallRuleProperties

名字 描述 价值
endIp地址 Mongo 群集防火墙规则的结束 IP 地址。 必须是 IPv4 格式。 字符串

约束：
模式 = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ （必需）
startIpAddress （启动 IpAddress） Mongo 群集防火墙规则的起始 IP 地址。 必须是 IPv4 格式。 字符串

约束：
模式 = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ （必需）

用法示例

Terraform 示例

部署 Azure Cosmos DB for MongoDB（vCore）防火墙规则的基本示例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus3"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

data "azapi_client_config" "current" {}

resource "azapi_resource" "mongoCluster" {
  type      = "Microsoft.DocumentDB/mongoClusters@2025-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      authConfig = {
        allowedModes = ["MicrosoftEntraID"]
      }
      compute = {
        tier = "M40"
      }
      highAvailability = {
        targetMode = "Disabled"
      }
      previewFeatures = [
        "ShardRebalancer"
      ]
      publicNetworkAccess = "Enabled"
      serverVersion       = "5.0"
      sharding = {
        shardCount = 1
      }
      storage = {
        sizeGb = 32
      }
    }
  }
  tags = {
    Environment = "Test"
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "firewallRule" {
  type      = "Microsoft.DocumentDB/mongoClusters/firewallRules@2025-09-01"
  parent_id = azapi_resource.mongoCluster.id
  name      = var.resource_name
  body = {
    properties = {
      endIpAddress   = "0.0.0.0"
      startIpAddress = "0.0.0.0"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on