Microsoft.Network routeFilters/routeFilterRules 2024-05-01
- Latest
- 2024-05-01
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
- 2018-07-01
- 2018-06-01
- 2018-04-01
- 2018-02-01
- 2018-01-01
- 2017-11-01
- 2017-10-01
- 2017-09-01
- 2017-08-01
- 2017-06-01
- 2017-03-30
- 2017-03-01
- 2016-12-01
Bicep resource definition
The routeFilters/routeFilterRules 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/routeFilterRules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/routeFilters/routeFilterRules@2024-05-01' = {
parent: resourceSymbolicName
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:
- 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/routeFilterRules resource, add the following JSON to your template.
{
"type": "Microsoft.Network/routeFilters/routeFilterRules",
"apiVersion": "2024-05-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-05-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-05-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-05-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) |