Microsoft. DocumentDB mongoClusters/firewallRules 2024-10-01-preview

Definizione di risorsa Bicep

Il tipo di risorsa mongoClusters/firewallRules può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Esempi di utilizzo

Esempi bicep

Un esempio base di implementazione di Azure Cosmos DB per la regola firewall di 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' = {
  name: resourceName
  parent: mongoCluster
  properties: {
    endIpAddress: '0.0.0.0'
    startIpAddress: '0.0.0.0'
  }
}

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/mongoClusters/firewallRules, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

Microsoft.DocumentDB/mongoClusters/firewallRules

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 80
Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: mongoClusters
proprietà Proprietà specifiche della risorsa. Proprietà FirewallRule

Proprietà FirewallRule

Nome Descrizione Valore
endIpAddress Indirizzo IP finale della regola del firewall del cluster mongo. Deve essere formato IPv4. corda

Vincoli:
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])$ (obbligatorio)
startIpAddress Indirizzo IP iniziale della regola del firewall del cluster mongo. Deve essere formato IPv4. corda

Vincoli:
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])$ (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa mongoClusters/firewallRules può essere distribuito con operazioni destinate a:

Esempi di utilizzo

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/mongoClusters/firewallRules, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

Microsoft.DocumentDB/mongoClusters/firewallRules

Nome Descrizione Valore
versione dell'API Versione dell'API '2024-10-01-anteprima'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 80
Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (obbligatorio)
proprietà Proprietà specifiche della risorsa. Proprietà FirewallRule
digitare Tipo di risorsa 'Microsoft.DocumentDB/mongoClusters/firewallRules'

Proprietà FirewallRule

Nome Descrizione Valore
endIpAddress Indirizzo IP finale della regola del firewall del cluster mongo. Deve essere formato IPv4. corda

Vincoli:
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])$ (obbligatorio)
startIpAddress Indirizzo IP iniziale della regola del firewall del cluster mongo. Deve essere formato IPv4. corda

Vincoli:
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])$ (obbligatorio)

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa mongoClusters/firewallRules può essere distribuito con operazioni destinate a:

  • Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.

Esempi di utilizzo

Esempi di Terraform

Un esempio base di implementazione di Azure Cosmos DB per la regola firewall di 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    = ["*"]
}

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/mongoClusters/firewallRules, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

Microsoft.DocumentDB/mongoClusters/firewallRules

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 80
Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: mongoClusters
proprietà Proprietà specifiche della risorsa. Proprietà FirewallRule
digitare Tipo di risorsa "Microsoft.DocumentDB/mongoClusters/firewallRules@2024-10-01-preview"

Proprietà FirewallRule

Nome Descrizione Valore
endIpAddress Indirizzo IP finale della regola del firewall del cluster mongo. Deve essere formato IPv4. corda

Vincoli:
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])$ (obbligatorio)
startIpAddress Indirizzo IP iniziale della regola del firewall del cluster mongo. Deve essere formato IPv4. corda

Vincoli:
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])$ (obbligatorio)
  • Last updated on