Microsoft.DocumentDB mongoClusters/firewallRules
Bicep resource definition
The mongoClusters/firewallRules resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters/firewallRules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters/firewallRules@2024-10-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
endIpAddress: 'string'
startIpAddress: 'string'
}
}
Property values
FirewallRuleProperties
| Name | Description | Value |
|---|---|---|
| endIpAddress | The end IP address of the mongo cluster firewall rule. Must be IPv4 format. | 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])$ (required) |
| startIpAddress | The start IP address of the mongo cluster firewall rule. Must be IPv4 format. | 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])$ (required) |
Microsoft.DocumentDB/mongoClusters/firewallRules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: mongoClusters |
| properties | The resource-specific properties for this resource. | FirewallRuleProperties |
ARM template resource definition
The mongoClusters/firewallRules resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters/firewallRules resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/mongoClusters/firewallRules",
"apiVersion": "2024-10-01-preview",
"name": "string",
"properties": {
"endIpAddress": "string",
"startIpAddress": "string"
}
}
Property values
FirewallRuleProperties
| Name | Description | Value |
|---|---|---|
| endIpAddress | The end IP address of the mongo cluster firewall rule. Must be IPv4 format. | 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])$ (required) |
| startIpAddress | The start IP address of the mongo cluster firewall rule. Must be IPv4 format. | 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])$ (required) |
Microsoft.DocumentDB/mongoClusters/firewallRules
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-10-01-preview' |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (required) |
| properties | The resource-specific properties for this resource. | FirewallRuleProperties |
| type | The resource type | 'Microsoft.DocumentDB/mongoClusters/firewallRules' |
Terraform (AzAPI provider) resource definition
The mongoClusters/firewallRules resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DocumentDB/mongoClusters/firewallRules resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters/firewallRules@2024-10-01-preview"
name = "string"
body = jsonencode({
properties = {
endIpAddress = "string"
startIpAddress = "string"
}
})
}
Property values
FirewallRuleProperties
| Name | Description | Value |
|---|---|---|
| endIpAddress | The end IP address of the mongo cluster firewall rule. Must be IPv4 format. | 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])$ (required) |
| startIpAddress | The start IP address of the mongo cluster firewall rule. Must be IPv4 format. | 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])$ (required) |
Microsoft.DocumentDB/mongoClusters/firewallRules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[a-zA-Z0-9][-_.a-zA-Z0-9]* (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: mongoClusters |
| properties | The resource-specific properties for this resource. | FirewallRuleProperties |
| type | The resource type | "Microsoft.DocumentDB/mongoClusters/firewallRules@2024-10-01-preview" |