Microsoft.Network firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts 2023-11-01
Bicep resource definition
The firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts 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.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts@2023-11-01' = {
name: 'default'
parent: resourceSymbolicName
properties: {
priority: int
ruleCollections: [
{
name: 'string'
priority: int
ruleCollectionType: 'string'
// For remaining properties, see FirewallPolicyRuleCollection objects
}
]
}
}
FirewallPolicyRuleCollection objects
Set the ruleCollectionType property to specify the type of object.
For FirewallPolicyFilterRuleCollection, use:
ruleCollectionType: 'FirewallPolicyFilterRuleCollection'
action: {
type: 'string'
}
rules: [
{
description: 'string'
name: 'string'
ruleType: 'string'
// For remaining properties, see FirewallPolicyRule objects
}
]
For FirewallPolicyNatRuleCollection, use:
ruleCollectionType: 'FirewallPolicyNatRuleCollection'
action: {
type: 'DNAT'
}
rules: [
{
description: 'string'
name: 'string'
ruleType: 'string'
// For remaining properties, see FirewallPolicyRule objects
}
]
FirewallPolicyRule objects
Set the ruleType property to specify the type of object.
For ApplicationRule, use:
ruleType: 'ApplicationRule'
destinationAddresses: [
'string'
]
fqdnTags: [
'string'
]
httpHeadersToInsert: [
{
headerName: 'string'
headerValue: 'string'
}
]
protocols: [
{
port: int
protocolType: 'string'
}
]
sourceAddresses: [
'string'
]
sourceIpGroups: [
'string'
]
targetFqdns: [
'string'
]
targetUrls: [
'string'
]
terminateTLS: bool
webCategories: [
'string'
]
For NatRule, use:
ruleType: 'NatRule'
destinationAddresses: [
'string'
]
destinationPorts: [
'string'
]
ipProtocols: [
'string'
]
sourceAddresses: [
'string'
]
sourceIpGroups: [
'string'
]
translatedAddress: 'string'
translatedFqdn: 'string'
translatedPort: 'string'
For NetworkRule, use:
ruleType: 'NetworkRule'
destinationAddresses: [
'string'
]
destinationFqdns: [
'string'
]
destinationIpGroups: [
'string'
]
destinationPorts: [
'string'
]
ipProtocols: [
'string'
]
sourceAddresses: [
'string'
]
sourceIpGroups: [
'string'
]
Property values
firewallPolicies/ruleCollectionGroups/ruleCollection...
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
'default' |
| 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: ruleCollectionGroups |
| properties | The properties of the firewall policy rule collection group. | FirewallPolicyRuleCollectionGroupDraftProperties |
FirewallPolicyRuleCollectionGroupDraftProperties
| Name | Description | Value |
|---|---|---|
| priority | Priority of the Firewall Policy Rule Collection Group resource. | int Constraints: Min value = 100 Max value = 65000 |
| ruleCollections | Group of Firewall Policy rule collections. | FirewallPolicyRuleCollection[] |
FirewallPolicyRuleCollection
| Name | Description | Value |
|---|---|---|
| name | The name of the rule collection. | string |
| priority | Priority of the Firewall Policy Rule Collection resource. | int Constraints: Min value = 100 Max value = 65000 |
| ruleCollectionType | Set the object type | FirewallPolicyFilterRuleCollection FirewallPolicyNatRuleCollection (required) |
FirewallPolicyFilterRuleCollection
| Name | Description | Value |
|---|---|---|
| ruleCollectionType | The type of the rule collection. | 'FirewallPolicyFilterRuleCollection' (required) |
| action | The action type of a Filter rule collection. | FirewallPolicyFilterRuleCollectionAction |
| rules | List of rules included in a rule collection. | FirewallPolicyRule[] |
FirewallPolicyFilterRuleCollectionAction
| Name | Description | Value |
|---|---|---|
| type | The type of action. | 'Allow' 'Deny' |
FirewallPolicyRule
| Name | Description | Value |
|---|---|---|
| description | Description of the rule. | string |
| name | Name of the rule. | string |
| ruleType | Set the object type | ApplicationRule NatRule NetworkRule (required) |
ApplicationRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | 'ApplicationRule' (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| fqdnTags | List of FQDN Tags for this rule. | string[] |
| httpHeadersToInsert | List of HTTP/S headers to insert. | FirewallPolicyHttpHeaderToInsert[] |
| protocols | Array of Application Protocols. | FirewallPolicyRuleApplicationProtocol[] |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
| targetFqdns | List of FQDNs for this rule. | string[] |
| targetUrls | List of Urls for this rule condition. | string[] |
| terminateTLS | Terminate TLS connections for this rule. | bool |
| webCategories | List of destination azure web categories. | string[] |
FirewallPolicyHttpHeaderToInsert
| Name | Description | Value |
|---|---|---|
| headerName | Contains the name of the header | string |
| headerValue | Contains the value of the header | string |
FirewallPolicyRuleApplicationProtocol
| Name | Description | Value |
|---|---|---|
| port | Port number for the protocol, cannot be greater than 64000. | int Constraints: Min value = 0 Max value = 64000 |
| protocolType | Protocol type. | 'Http' 'Https' |
NatRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | 'NatRule' (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| destinationPorts | List of destination ports. | string[] |
| ipProtocols | Array of FirewallPolicyRuleNetworkProtocols. | String array containing any of: 'Any' 'ICMP' 'TCP' 'UDP' |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
| translatedAddress | The translated address for this NAT rule. | string |
| translatedFqdn | The translated FQDN for this NAT rule. | string |
| translatedPort | The translated port for this NAT rule. | string |
NetworkRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | 'NetworkRule' (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| destinationFqdns | List of destination FQDNs. | string[] |
| destinationIpGroups | List of destination IpGroups for this rule. | string[] |
| destinationPorts | List of destination ports. | string[] |
| ipProtocols | Array of FirewallPolicyRuleNetworkProtocols. | String array containing any of: 'Any' 'ICMP' 'TCP' 'UDP' |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
FirewallPolicyNatRuleCollection
| Name | Description | Value |
|---|---|---|
| ruleCollectionType | The type of the rule collection. | 'FirewallPolicyNatRuleCollection' (required) |
| action | The action type of a Nat rule collection. | FirewallPolicyNatRuleCollectionAction |
| rules | List of rules included in a rule collection. | FirewallPolicyRule[] |
FirewallPolicyNatRuleCollectionAction
| Name | Description | Value |
|---|---|---|
| type | The type of action. | 'DNAT' |
ARM template resource definition
The firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts 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.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts resource, add the following JSON to your template.
{
"type": "Microsoft.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts",
"apiVersion": "2023-11-01",
"name": "default",
"properties": {
"priority": "int",
"ruleCollections": [
{
"name": "string",
"priority": "int",
"ruleCollectionType": "string"
// For remaining properties, see FirewallPolicyRuleCollection objects
}
]
}
}
FirewallPolicyRuleCollection objects
Set the ruleCollectionType property to specify the type of object.
For FirewallPolicyFilterRuleCollection, use:
"ruleCollectionType": "FirewallPolicyFilterRuleCollection",
"action": {
"type": "string"
},
"rules": [
{
"description": "string",
"name": "string",
"ruleType": "string"
// For remaining properties, see FirewallPolicyRule objects
}
]
For FirewallPolicyNatRuleCollection, use:
"ruleCollectionType": "FirewallPolicyNatRuleCollection",
"action": {
"type": "DNAT"
},
"rules": [
{
"description": "string",
"name": "string",
"ruleType": "string"
// For remaining properties, see FirewallPolicyRule objects
}
]
FirewallPolicyRule objects
Set the ruleType property to specify the type of object.
For ApplicationRule, use:
"ruleType": "ApplicationRule",
"destinationAddresses": [ "string" ],
"fqdnTags": [ "string" ],
"httpHeadersToInsert": [
{
"headerName": "string",
"headerValue": "string"
}
],
"protocols": [
{
"port": "int",
"protocolType": "string"
}
],
"sourceAddresses": [ "string" ],
"sourceIpGroups": [ "string" ],
"targetFqdns": [ "string" ],
"targetUrls": [ "string" ],
"terminateTLS": "bool",
"webCategories": [ "string" ]
For NatRule, use:
"ruleType": "NatRule",
"destinationAddresses": [ "string" ],
"destinationPorts": [ "string" ],
"ipProtocols": [ "string" ],
"sourceAddresses": [ "string" ],
"sourceIpGroups": [ "string" ],
"translatedAddress": "string",
"translatedFqdn": "string",
"translatedPort": "string"
For NetworkRule, use:
"ruleType": "NetworkRule",
"destinationAddresses": [ "string" ],
"destinationFqdns": [ "string" ],
"destinationIpGroups": [ "string" ],
"destinationPorts": [ "string" ],
"ipProtocols": [ "string" ],
"sourceAddresses": [ "string" ],
"sourceIpGroups": [ "string" ]
Property values
firewallPolicies/ruleCollectionGroups/ruleCollection...
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts' |
| apiVersion | The resource api version | '2023-11-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'default' |
| properties | The properties of the firewall policy rule collection group. | FirewallPolicyRuleCollectionGroupDraftProperties |
FirewallPolicyRuleCollectionGroupDraftProperties
| Name | Description | Value |
|---|---|---|
| priority | Priority of the Firewall Policy Rule Collection Group resource. | int Constraints: Min value = 100 Max value = 65000 |
| ruleCollections | Group of Firewall Policy rule collections. | FirewallPolicyRuleCollection[] |
FirewallPolicyRuleCollection
| Name | Description | Value |
|---|---|---|
| name | The name of the rule collection. | string |
| priority | Priority of the Firewall Policy Rule Collection resource. | int Constraints: Min value = 100 Max value = 65000 |
| ruleCollectionType | Set the object type | FirewallPolicyFilterRuleCollection FirewallPolicyNatRuleCollection (required) |
FirewallPolicyFilterRuleCollection
| Name | Description | Value |
|---|---|---|
| ruleCollectionType | The type of the rule collection. | 'FirewallPolicyFilterRuleCollection' (required) |
| action | The action type of a Filter rule collection. | FirewallPolicyFilterRuleCollectionAction |
| rules | List of rules included in a rule collection. | FirewallPolicyRule[] |
FirewallPolicyFilterRuleCollectionAction
| Name | Description | Value |
|---|---|---|
| type | The type of action. | 'Allow' 'Deny' |
FirewallPolicyRule
| Name | Description | Value |
|---|---|---|
| description | Description of the rule. | string |
| name | Name of the rule. | string |
| ruleType | Set the object type | ApplicationRule NatRule NetworkRule (required) |
ApplicationRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | 'ApplicationRule' (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| fqdnTags | List of FQDN Tags for this rule. | string[] |
| httpHeadersToInsert | List of HTTP/S headers to insert. | FirewallPolicyHttpHeaderToInsert[] |
| protocols | Array of Application Protocols. | FirewallPolicyRuleApplicationProtocol[] |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
| targetFqdns | List of FQDNs for this rule. | string[] |
| targetUrls | List of Urls for this rule condition. | string[] |
| terminateTLS | Terminate TLS connections for this rule. | bool |
| webCategories | List of destination azure web categories. | string[] |
FirewallPolicyHttpHeaderToInsert
| Name | Description | Value |
|---|---|---|
| headerName | Contains the name of the header | string |
| headerValue | Contains the value of the header | string |
FirewallPolicyRuleApplicationProtocol
| Name | Description | Value |
|---|---|---|
| port | Port number for the protocol, cannot be greater than 64000. | int Constraints: Min value = 0 Max value = 64000 |
| protocolType | Protocol type. | 'Http' 'Https' |
NatRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | 'NatRule' (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| destinationPorts | List of destination ports. | string[] |
| ipProtocols | Array of FirewallPolicyRuleNetworkProtocols. | String array containing any of: 'Any' 'ICMP' 'TCP' 'UDP' |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
| translatedAddress | The translated address for this NAT rule. | string |
| translatedFqdn | The translated FQDN for this NAT rule. | string |
| translatedPort | The translated port for this NAT rule. | string |
NetworkRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | 'NetworkRule' (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| destinationFqdns | List of destination FQDNs. | string[] |
| destinationIpGroups | List of destination IpGroups for this rule. | string[] |
| destinationPorts | List of destination ports. | string[] |
| ipProtocols | Array of FirewallPolicyRuleNetworkProtocols. | String array containing any of: 'Any' 'ICMP' 'TCP' 'UDP' |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
FirewallPolicyNatRuleCollection
| Name | Description | Value |
|---|---|---|
| ruleCollectionType | The type of the rule collection. | 'FirewallPolicyNatRuleCollection' (required) |
| action | The action type of a Nat rule collection. | FirewallPolicyNatRuleCollectionAction |
| rules | List of rules included in a rule collection. | FirewallPolicyRule[] |
FirewallPolicyNatRuleCollectionAction
| Name | Description | Value |
|---|---|---|
| type | The type of action. | 'DNAT' |
Terraform (AzAPI provider) resource definition
The firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts 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.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts@2023-11-01"
name = "default"
parent_id = "string"
body = jsonencode({
properties = {
priority = int
ruleCollections = [
{
name = "string"
priority = int
ruleCollectionType = "string"
// For remaining properties, see FirewallPolicyRuleCollection objects
}
]
}
})
}
FirewallPolicyRuleCollection objects
Set the ruleCollectionType property to specify the type of object.
For FirewallPolicyFilterRuleCollection, use:
ruleCollectionType = "FirewallPolicyFilterRuleCollection"
action = {
type = "string"
}
rules = [
{
description = "string"
name = "string"
ruleType = "string"
// For remaining properties, see FirewallPolicyRule objects
}
]
For FirewallPolicyNatRuleCollection, use:
ruleCollectionType = "FirewallPolicyNatRuleCollection"
action = {
type = "DNAT"
}
rules = [
{
description = "string"
name = "string"
ruleType = "string"
// For remaining properties, see FirewallPolicyRule objects
}
]
FirewallPolicyRule objects
Set the ruleType property to specify the type of object.
For ApplicationRule, use:
ruleType = "ApplicationRule"
destinationAddresses = [
"string"
]
fqdnTags = [
"string"
]
httpHeadersToInsert = [
{
headerName = "string"
headerValue = "string"
}
]
protocols = [
{
port = int
protocolType = "string"
}
]
sourceAddresses = [
"string"
]
sourceIpGroups = [
"string"
]
targetFqdns = [
"string"
]
targetUrls = [
"string"
]
terminateTLS = bool
webCategories = [
"string"
]
For NatRule, use:
ruleType = "NatRule"
destinationAddresses = [
"string"
]
destinationPorts = [
"string"
]
ipProtocols = [
"string"
]
sourceAddresses = [
"string"
]
sourceIpGroups = [
"string"
]
translatedAddress = "string"
translatedFqdn = "string"
translatedPort = "string"
For NetworkRule, use:
ruleType = "NetworkRule"
destinationAddresses = [
"string"
]
destinationFqdns = [
"string"
]
destinationIpGroups = [
"string"
]
destinationPorts = [
"string"
]
ipProtocols = [
"string"
]
sourceAddresses = [
"string"
]
sourceIpGroups = [
"string"
]
Property values
firewallPolicies/ruleCollectionGroups/ruleCollection...
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Network/firewallPolicies/ruleCollectionGroups/ruleCollectionGroupDrafts@2023-11-01" |
| name | The resource name | "default" |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: ruleCollectionGroups |
| properties | The properties of the firewall policy rule collection group. | FirewallPolicyRuleCollectionGroupDraftProperties |
FirewallPolicyRuleCollectionGroupDraftProperties
| Name | Description | Value |
|---|---|---|
| priority | Priority of the Firewall Policy Rule Collection Group resource. | int Constraints: Min value = 100 Max value = 65000 |
| ruleCollections | Group of Firewall Policy rule collections. | FirewallPolicyRuleCollection[] |
FirewallPolicyRuleCollection
| Name | Description | Value |
|---|---|---|
| name | The name of the rule collection. | string |
| priority | Priority of the Firewall Policy Rule Collection resource. | int Constraints: Min value = 100 Max value = 65000 |
| ruleCollectionType | Set the object type | FirewallPolicyFilterRuleCollection FirewallPolicyNatRuleCollection (required) |
FirewallPolicyFilterRuleCollection
| Name | Description | Value |
|---|---|---|
| ruleCollectionType | The type of the rule collection. | "FirewallPolicyFilterRuleCollection" (required) |
| action | The action type of a Filter rule collection. | FirewallPolicyFilterRuleCollectionAction |
| rules | List of rules included in a rule collection. | FirewallPolicyRule[] |
FirewallPolicyFilterRuleCollectionAction
| Name | Description | Value |
|---|---|---|
| type | The type of action. | "Allow" "Deny" |
FirewallPolicyRule
| Name | Description | Value |
|---|---|---|
| description | Description of the rule. | string |
| name | Name of the rule. | string |
| ruleType | Set the object type | ApplicationRule NatRule NetworkRule (required) |
ApplicationRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | "ApplicationRule" (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| fqdnTags | List of FQDN Tags for this rule. | string[] |
| httpHeadersToInsert | List of HTTP/S headers to insert. | FirewallPolicyHttpHeaderToInsert[] |
| protocols | Array of Application Protocols. | FirewallPolicyRuleApplicationProtocol[] |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
| targetFqdns | List of FQDNs for this rule. | string[] |
| targetUrls | List of Urls for this rule condition. | string[] |
| terminateTLS | Terminate TLS connections for this rule. | bool |
| webCategories | List of destination azure web categories. | string[] |
FirewallPolicyHttpHeaderToInsert
| Name | Description | Value |
|---|---|---|
| headerName | Contains the name of the header | string |
| headerValue | Contains the value of the header | string |
FirewallPolicyRuleApplicationProtocol
| Name | Description | Value |
|---|---|---|
| port | Port number for the protocol, cannot be greater than 64000. | int Constraints: Min value = 0 Max value = 64000 |
| protocolType | Protocol type. | "Http" "Https" |
NatRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | "NatRule" (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| destinationPorts | List of destination ports. | string[] |
| ipProtocols | Array of FirewallPolicyRuleNetworkProtocols. | String array containing any of: "Any" "ICMP" "TCP" "UDP" |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
| translatedAddress | The translated address for this NAT rule. | string |
| translatedFqdn | The translated FQDN for this NAT rule. | string |
| translatedPort | The translated port for this NAT rule. | string |
NetworkRule
| Name | Description | Value |
|---|---|---|
| ruleType | Rule Type. | "NetworkRule" (required) |
| destinationAddresses | List of destination IP addresses or Service Tags. | string[] |
| destinationFqdns | List of destination FQDNs. | string[] |
| destinationIpGroups | List of destination IpGroups for this rule. | string[] |
| destinationPorts | List of destination ports. | string[] |
| ipProtocols | Array of FirewallPolicyRuleNetworkProtocols. | String array containing any of: "Any" "ICMP" "TCP" "UDP" |
| sourceAddresses | List of source IP addresses for this rule. | string[] |
| sourceIpGroups | List of source IpGroups for this rule. | string[] |
FirewallPolicyNatRuleCollection
| Name | Description | Value |
|---|---|---|
| ruleCollectionType | The type of the rule collection. | "FirewallPolicyNatRuleCollection" (required) |
| action | The action type of a Nat rule collection. | FirewallPolicyNatRuleCollectionAction |
| rules | List of rules included in a rule collection. | FirewallPolicyRule[] |
FirewallPolicyNatRuleCollectionAction
| Name | Description | Value |
|---|---|---|
| type | The type of action. | "DNAT" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for