Microsoft.Network routeFilters 2024-05-01
Bicep resource definition
The routeFilters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/routeFilters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/routeFilters@2024-05-01' = {
location: 'string'
name: 'string'
properties: {
rules: [
{
id: 'string'
location: 'string'
name: 'string'
properties: {
access: 'string'
communities: [
'string'
]
routeFilterRuleType: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.Network/routeFilters
Name |
Description |
Value |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Properties of the route filter. |
RouteFilterPropertiesFormat |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
Name |
Description |
Value |
rules |
Collection of RouteFilterRules contained within a route filter. |
RouteFilterRule[] |
RouteFilterRule
Name |
Description |
Value |
id |
Resource ID. |
string |
location |
Resource location. |
string |
name |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
Properties of the route filter rule. |
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 resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/routeFilters resource, add the following JSON to your template.
{
"type": "Microsoft.Network/routeFilters",
"apiVersion": "2024-05-01",
"name": "string",
"location": "string",
"properties": {
"rules": [
{
"id": "string",
"location": "string",
"name": "string",
"properties": {
"access": "string",
"communities": [ "string" ],
"routeFilterRuleType": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.Network/routeFilters
Name |
Description |
Value |
apiVersion |
The api version |
'2024-05-01' |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Properties of the route filter. |
RouteFilterPropertiesFormat |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
type |
The resource type |
'Microsoft.Network/routeFilters' |
Name |
Description |
Value |
rules |
Collection of RouteFilterRules contained within a route filter. |
RouteFilterRule[] |
RouteFilterRule
Name |
Description |
Value |
id |
Resource ID. |
string |
location |
Resource location. |
string |
name |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
Properties of the route filter rule. |
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) |
The routeFilters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Network/routeFilters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/routeFilters@2024-05-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
rules = [
{
id = "string"
location = "string"
name = "string"
properties = {
access = "string"
communities = [
"string"
]
routeFilterRuleType = "string"
}
}
]
}
})
}
Property values
Microsoft.Network/routeFilters
Name |
Description |
Value |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Properties of the route filter. |
RouteFilterPropertiesFormat |
tags |
Resource tags |
Dictionary of tag names and values. |
type |
The resource type |
"Microsoft.Network/routeFilters@2024-05-01" |
Name |
Description |
Value |
rules |
Collection of RouteFilterRules contained within a route filter. |
RouteFilterRule[] |
RouteFilterRule
Name |
Description |
Value |
id |
Resource ID. |
string |
location |
Resource location. |
string |
name |
The name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
Properties of the route filter rule. |
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) |