Microsoft. DocumentDB mongoClusters/firewallRules 2026-02-01-preview

Definição de recursos do bíceps

O tipo de recurso mongoClusters/firewallRules pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters/firewallRules, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters/firewallRules

Name Description valor
nome O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (obrigatório)
elemento principal No Bicep, podes especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para mais informações, consulte Child resource outside parent resource.		 Nome simbólico para recurso do tipo: mongoClusters
Propriedades As propriedades específicas do recurso para este recurso. FirewallRuleProperties

FirewallRuleProperties

Name Description valor
endIpAddress O endereço IP final da regra de firewall do cluster mongo. Deve ser formato IPv4. string

Restrições:
Padrão = ^(([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])$ (obrigatório)
startIpAddress O endereço IP inicial da regra de firewall do cluster mongo. Deve ser formato IPv4. string

Restrições:
Padrão = ^(([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])$ (obrigatório)

Exemplos de uso

Amostras do Bicep

Um exemplo básico de implementação da Regra de Firewall do Azure Cosmos DB para 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'
  }
}

Definição de recurso de modelo ARM

O tipo de recurso mongoClusters/firewallRules pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters/firewallRules, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters/firewallRules

Name Description valor
apiVersion A versão api 'Pré-visualização 2026-02-01'
nome O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (obrigatório)
Propriedades As propriedades específicas do recurso para este recurso. FirewallRuleProperties
tipo O tipo de recurso 'Microsoft.DocumentDB/mongoClusters/firewallRules'

FirewallRuleProperties

Name Description valor
endIpAddress O endereço IP final da regra de firewall do cluster mongo. Deve ser formato IPv4. string

Restrições:
Padrão = ^(([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])$ (obrigatório)
startIpAddress O endereço IP inicial da regra de firewall do cluster mongo. Deve ser formato IPv4. string

Restrições:
Padrão = ^(([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])$ (obrigatório)

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso mongoClusters/firewallRules pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters/firewallRules, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters/firewallRules

Name Description valor
nome O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: mongoClusters
Propriedades As propriedades específicas do recurso para este recurso. FirewallRuleProperties
tipo O tipo de recurso "Microsoft. DocumentDB/mongoClusters/firewallRules@2026-02-01-preview"

FirewallRuleProperties

Name Description valor
endIpAddress O endereço IP final da regra de firewall do cluster mongo. Deve ser formato IPv4. string

Restrições:
Padrão = ^(([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])$ (obrigatório)
startIpAddress O endereço IP inicial da regra de firewall do cluster mongo. Deve ser formato IPv4. string

Restrições:
Padrão = ^(([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])$ (obrigatório)

Exemplos de uso

Amostras Terraform

Um exemplo básico de implementação da Regra de Firewall do Azure Cosmos DB para 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