Microsoft.Network routeFilters 2022-09-01
Bicep resource definition
The routeFilters 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/routeFilters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/routeFilters@2022-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
rules: [
{
id: 'string'
location: 'string'
name: 'string'
properties: {
access: 'string'
communities: [
'string'
]
routeFilterRuleType: 'Community'
}
}
]
}
}
Property values
routeFilters
Name | Description | Value |
---|---|---|
name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore. |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Properties of the route filter. | RouteFilterPropertiesFormat |
RouteFilterPropertiesFormat
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 |
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:
- 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/routeFilters resource, add the following JSON to your template.
{
"type": "Microsoft.Network/routeFilters",
"apiVersion": "2022-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"rules": [
{
"id": "string",
"location": "string",
"name": "string",
"properties": {
"access": "string",
"communities": [ "string" ],
"routeFilterRuleType": "Community"
}
}
]
}
}
Property values
routeFilters
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Network/routeFilters' |
apiVersion | The resource api version | '2022-09-01' |
name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore. |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
properties | Properties of the route filter. | RouteFilterPropertiesFormat |
RouteFilterPropertiesFormat
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 |
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 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/routeFilters@2022-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
rules = [
{
id = "string"
location = "string"
name = "string"
properties = {
access = "string"
communities = [
"string"
]
routeFilterRuleType = "Community"
}
}
]
}
})
}
Property values
routeFilters
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Network/routeFilters@2022-09-01" |
name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. End alphanumeric or underscore. |
location | Resource location. | string |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Resource tags. | Dictionary of tag names and values. |
properties | Properties of the route filter. | RouteFilterPropertiesFormat |
RouteFilterPropertiesFormat
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 |
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) |