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

Bicep-Ressourcendefinition

Der MongoClusters/firewallRules-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Verwendungsbeispiele

Beispiele für Bicep

Ein grundlegendes Beispiel für die Bereitstellung von Azure Cosmos DB für die MongoDB (vCore) Firewall-Regel.

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' = {
  name: resourceName
  parent: mongoCluster
  properties: {
    endIpAddress: '0.0.0.0'
    startIpAddress: '0.0.0.0'
  }
}

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters/firewallRules-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

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

Eigenschaftswerte

Microsoft.DocumentDB/mongoClusters/firewallRules

Name Beschreibung Wert
Name Der Ressourcenname string

Constraints:
Min. Länge = 1
Max. Länge = 80
Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (erforderlich)
parent In Bicep kann man die Elternressource für eine Kindressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Child resource outside parent resource.		 Symbolischer Name für Ressource des Typs: mongoClusters
Eigenschaften Die ressourcenspezifischen Eigenschaften für diese Ressource. FirewallRuleProperties

FirewallRuleProperties

Name Beschreibung Wert
endIpAddress Die IP-Endadresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein. string

Constraints:
Pattern = ^(([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])$ (erforderlich)
startIpAddress Die Start-IP-Adresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein. string

Constraints:
Pattern = ^(([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])$ (erforderlich)

ARM-Vorlagenressourcendefinition

Der MongoClusters/firewallRules-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Verwendungsbeispiele

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters/firewallRules-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

Microsoft.DocumentDB/mongoClusters/firewallRules

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2026-02-01-Vorschau'
Name Der Ressourcenname string

Constraints:
Min. Länge = 1
Max. Länge = 80
Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (erforderlich)
Eigenschaften Die ressourcenspezifischen Eigenschaften für diese Ressource. FirewallRuleProperties
type Der Ressourcentyp 'Microsoft.DocumentDB/mongoClusters/firewallRules'

FirewallRuleProperties

Name Beschreibung Wert
endIpAddress Die IP-Endadresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein. string

Constraints:
Pattern = ^(([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])$ (erforderlich)
startIpAddress Die Start-IP-Adresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein. string

Constraints:
Pattern = ^(([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])$ (erforderlich)

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der MongoClusters/firewallRules-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von Azure Cosmos DB für die MongoDB (vCore) Firewall-Regel.

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    = ["*"]
}

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters/firewallRules-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Microsoft.DocumentDB/mongoClusters/firewallRules

Name Beschreibung Wert
Name Der Ressourcenname string

Constraints:
Min. Länge = 1
Max. Länge = 80
Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: mongoClusters
Eigenschaften Die ressourcenspezifischen Eigenschaften für diese Ressource. FirewallRuleProperties
type Der Ressourcentyp "Microsoft. DocumentDB/mongoClusters/firewallRules@2026-02-01-preview"

FirewallRuleProperties

Name Beschreibung Wert
endIpAddress Die IP-Endadresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein. string

Constraints:
Pattern = ^(([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])$ (erforderlich)
startIpAddress Die Start-IP-Adresse der Mongo-Clusterfirewallregel. Muss das IPv4-Format sein. string

Constraints:
Pattern = ^(([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])$ (erforderlich)
  • Last updated on