Share via

Microsoft.Network routeFilters/routeFilterRules

  • Article

Bicep resource definition

The routeFilters/routeFilterRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/routeFilters/routeFilterRules@2024-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    access: 'string'
    communities: [
      'string'
    ]
    routeFilterRuleType: 'string'
  }
}

Property values

Microsoft.Network/routeFilters/routeFilterRules

Name Description Value
location Resource location. string
name The resource name string (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: routeFilters
properties Properties of the route filter rule. RouteFilterRulePropertiesFormat

RouteFilterRulePropertiesFormat

Name Description Value
access The access type of the rule. 'Allow'
'Deny' (required)
communities The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. string[] (required)
routeFilterRuleType The rule type of the rule. 'Community' (required)

ARM template resource definition

The routeFilters/routeFilterRules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/routeFilters/routeFilterRules resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/routeFilters/routeFilterRules",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "access": "string",
    "communities": [ "string" ],
    "routeFilterRuleType": "string"
  }
}

Property values

Microsoft.Network/routeFilters/routeFilterRules

Name Description Value
apiVersion The api version '2024-03-01'
location Resource location. string
name The resource name string (required)
properties Properties of the route filter rule. RouteFilterRulePropertiesFormat
type The resource type 'Microsoft.Network/routeFilters/routeFilterRules'

RouteFilterRulePropertiesFormat

Name Description Value
access The access type of the rule. 'Allow'
'Deny' (required)
communities The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. string[] (required)
routeFilterRuleType The rule type of the rule. 'Community' (required)

Terraform (AzAPI provider) resource definition

The routeFilters/routeFilterRules 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/routeFilters/routeFilterRules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/routeFilters/routeFilterRules@2024-03-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      access = "string"
      communities = [
        "string"
      ]
      routeFilterRuleType = "string"
    }
  })
}

Property values

Microsoft.Network/routeFilters/routeFilterRules

Name Description Value
location Resource location. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: routeFilters
properties Properties of the route filter rule. RouteFilterRulePropertiesFormat
type The resource type "Microsoft.Network/routeFilters/routeFilterRules@2024-03-01"

RouteFilterRulePropertiesFormat

Name Description Value
access The access type of the rule. 'Allow'
'Deny' (required)
communities The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. string[] (required)
routeFilterRuleType The rule type of the rule. 'Community' (required)