Microsoft.Network routeFilters 2018-02-01
- Article
-
-
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@2018-02-01' = {
location: 'string'
name: 'string'
properties: {
peerings: [
{
id: 'string'
name: 'string'
properties: {
azureASN: int
connections: [
{
id: 'string'
name: 'string'
properties: {
addressPrefix: 'string'
authorizationKey: 'string'
expressRouteCircuitPeering: {
id: 'string'
}
peerExpressRouteCircuitPeering: {
id: 'string'
}
}
}
]
gatewayManagerEtag: 'string'
ipv6PeeringConfig: {
microsoftPeeringConfig: {
advertisedCommunities: [
'string'
]
advertisedPublicPrefixes: [
'string'
]
advertisedPublicPrefixesState: 'string'
customerASN: int
legacyMode: int
routingRegistryName: 'string'
}
primaryPeerAddressPrefix: 'string'
routeFilter: {
id: 'string'
location: 'string'
properties: ...
tags: {
{customized property}: 'string'
}
}
secondaryPeerAddressPrefix: 'string'
state: 'string'
}
lastModifiedBy: 'string'
microsoftPeeringConfig: {
advertisedCommunities: [
'string'
]
advertisedPublicPrefixes: [
'string'
]
advertisedPublicPrefixesState: 'string'
customerASN: int
legacyMode: int
routingRegistryName: 'string'
}
peerASN: int
peeringType: 'string'
primaryAzurePort: 'string'
primaryPeerAddressPrefix: 'string'
provisioningState: 'string'
routeFilter: {
id: 'string'
location: 'string'
properties: ...
tags: {
{customized property}: 'string'
}
}
secondaryAzurePort: 'string'
secondaryPeerAddressPrefix: 'string'
sharedKey: 'string'
state: 'string'
stats: {
primarybytesIn: int
primarybytesOut: int
secondarybytesIn: int
secondarybytesOut: int
}
vlanId: int
}
}
]
rules: [
{
id: 'string'
location: 'string'
name: 'string'
properties: {
access: 'string'
communities: [
'string'
]
routeFilterRuleType: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
ExpressRouteCircuitConnection
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
|
ExpressRouteCircuitConnectionPropertiesFormat |
Name |
Description |
Value |
addressPrefix |
/29 IP address space to carve out Customer addresses for tunnels. |
string |
authorizationKey |
The authorization key. |
string |
expressRouteCircuitPeering |
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. |
SubResource |
peerExpressRouteCircuitPeering |
Reference to Express Route Circuit Private Peering Resource of the peered circuit. |
SubResource |
ExpressRouteCircuitPeering
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
|
ExpressRouteCircuitPeeringPropertiesFormat |
ExpressRouteCircuitPeeringConfig
Name |
Description |
Value |
advertisedCommunities |
The communities of bgp peering. Specified for microsoft peering |
string[] |
advertisedPublicPrefixes |
The reference of AdvertisedPublicPrefixes. |
string[] |
advertisedPublicPrefixesState |
AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. |
'Configured' 'Configuring' 'NotConfigured' 'ValidationNeeded' |
customerASN |
The CustomerASN of the peering. |
int |
legacyMode |
The legacy mode of the peering. |
int |
routingRegistryName |
The RoutingRegistryName of the configuration. |
string |
Name |
Description |
Value |
azureASN |
The Azure ASN. |
int |
connections |
The list of circuit connections associated with Azure Private Peering for this circuit. |
ExpressRouteCircuitConnection[] |
gatewayManagerEtag |
The GatewayManager Etag. |
string |
ipv6PeeringConfig |
The IPv6 peering configuration. |
Ipv6ExpressRouteCircuitPeeringConfig |
lastModifiedBy |
Gets whether the provider or the customer last modified the peering. |
string |
microsoftPeeringConfig |
The Microsoft peering configuration. |
ExpressRouteCircuitPeeringConfig |
peerASN |
The peer ASN. |
int
Constraints: Min value = 1 Max value = 4294967295 |
peeringType |
The peering type. |
'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering' |
primaryAzurePort |
The primary port. |
string |
primaryPeerAddressPrefix |
The primary address prefix. |
string |
provisioningState |
Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. |
string |
routeFilter |
The reference of the RouteFilter resource. |
RouteFilter |
secondaryAzurePort |
The secondary port. |
string |
secondaryPeerAddressPrefix |
The secondary address prefix. |
string |
sharedKey |
The shared key. |
string |
state |
The peering state. |
'Disabled' 'Enabled' |
stats |
Gets peering stats. |
ExpressRouteCircuitStats |
vlanId |
The VLAN ID. |
int |
Name |
Description |
Value |
primarybytesIn |
Gets BytesIn of the peering. |
int |
primarybytesOut |
Gets BytesOut of the peering. |
int |
secondarybytesIn |
Gets BytesIn of the peering. |
int |
secondarybytesOut |
Gets BytesOut of the peering. |
int |
Ipv6ExpressRouteCircuitPeeringConfig
Name |
Description |
Value |
microsoftPeeringConfig |
The Microsoft peering configuration. |
ExpressRouteCircuitPeeringConfig |
primaryPeerAddressPrefix |
The primary address prefix. |
string |
routeFilter |
The reference of the RouteFilter resource. |
RouteFilter |
secondaryPeerAddressPrefix |
The secondary address prefix. |
string |
state |
The state of peering. Possible values are: 'Disabled' and 'Enabled' |
'Disabled' 'Enabled' |
Microsoft.Network/routeFilters
Name |
Description |
Value |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Route Filter Resource |
RouteFilterPropertiesFormat |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
Name |
Description |
Value |
peerings |
A collection of references to express route circuit peerings. |
ExpressRouteCircuitPeering[] |
rules |
Collection of RouteFilterRules contained within a route filter. |
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 |
Route Filter Rule Resource |
RouteFilterRulePropertiesFormat |
Name |
Description |
Value |
access |
The access type of the rule. Valid values are: 'Allow', 'Deny' |
'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. Valid value is: 'Community' |
'Community' (required) |
Name |
Description |
Value |
id |
Resource ID. |
string |
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": "2018-02-01",
"name": "string",
"location": "string",
"properties": {
"peerings": [
{
"id": "string",
"name": "string",
"properties": {
"azureASN": "int",
"connections": [
{
"id": "string",
"name": "string",
"properties": {
"addressPrefix": "string",
"authorizationKey": "string",
"expressRouteCircuitPeering": {
"id": "string"
},
"peerExpressRouteCircuitPeering": {
"id": "string"
}
}
}
],
"gatewayManagerEtag": "string",
"ipv6PeeringConfig": {
"microsoftPeeringConfig": {
"advertisedCommunities": [ "string" ],
"advertisedPublicPrefixes": [ "string" ],
"advertisedPublicPrefixesState": "string",
"customerASN": "int",
"legacyMode": "int",
"routingRegistryName": "string"
},
"primaryPeerAddressPrefix": "string",
"routeFilter": {
"id": "string",
"location": "string",
"properties": ...,
"tags": {
"{customized property}": "string"
}
},
"secondaryPeerAddressPrefix": "string",
"state": "string"
},
"lastModifiedBy": "string",
"microsoftPeeringConfig": {
"advertisedCommunities": [ "string" ],
"advertisedPublicPrefixes": [ "string" ],
"advertisedPublicPrefixesState": "string",
"customerASN": "int",
"legacyMode": "int",
"routingRegistryName": "string"
},
"peerASN": "int",
"peeringType": "string",
"primaryAzurePort": "string",
"primaryPeerAddressPrefix": "string",
"provisioningState": "string",
"routeFilter": {
"id": "string",
"location": "string",
"properties": ...,
"tags": {
"{customized property}": "string"
}
},
"secondaryAzurePort": "string",
"secondaryPeerAddressPrefix": "string",
"sharedKey": "string",
"state": "string",
"stats": {
"primarybytesIn": "int",
"primarybytesOut": "int",
"secondarybytesIn": "int",
"secondarybytesOut": "int"
},
"vlanId": "int"
}
}
],
"rules": [
{
"id": "string",
"location": "string",
"name": "string",
"properties": {
"access": "string",
"communities": [ "string" ],
"routeFilterRuleType": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
ExpressRouteCircuitConnection
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
|
ExpressRouteCircuitConnectionPropertiesFormat |
ExpressRouteCircuitConnectionPropertiesFormat
Name |
Description |
Value |
addressPrefix |
/29 IP address space to carve out Customer addresses for tunnels. |
string |
authorizationKey |
The authorization key. |
string |
expressRouteCircuitPeering |
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. |
SubResource |
peerExpressRouteCircuitPeering |
Reference to Express Route Circuit Private Peering Resource of the peered circuit. |
SubResource |
ExpressRouteCircuitPeering
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
|
ExpressRouteCircuitPeeringPropertiesFormat |
ExpressRouteCircuitPeeringConfig
Name |
Description |
Value |
advertisedCommunities |
The communities of bgp peering. Specified for microsoft peering |
string[] |
advertisedPublicPrefixes |
The reference of AdvertisedPublicPrefixes. |
string[] |
advertisedPublicPrefixesState |
AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. |
'Configured' 'Configuring' 'NotConfigured' 'ValidationNeeded' |
customerASN |
The CustomerASN of the peering. |
int |
legacyMode |
The legacy mode of the peering. |
int |
routingRegistryName |
The RoutingRegistryName of the configuration. |
string |
ExpressRouteCircuitPeeringPropertiesFormat
Name |
Description |
Value |
azureASN |
The Azure ASN. |
int |
connections |
The list of circuit connections associated with Azure Private Peering for this circuit. |
ExpressRouteCircuitConnection[] |
gatewayManagerEtag |
The GatewayManager Etag. |
string |
ipv6PeeringConfig |
The IPv6 peering configuration. |
Ipv6ExpressRouteCircuitPeeringConfig |
lastModifiedBy |
Gets whether the provider or the customer last modified the peering. |
string |
microsoftPeeringConfig |
The Microsoft peering configuration. |
ExpressRouteCircuitPeeringConfig |
peerASN |
The peer ASN. |
int
Constraints: Min value = 1 Max value = 4294967295 |
peeringType |
The peering type. |
'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering' |
primaryAzurePort |
The primary port. |
string |
primaryPeerAddressPrefix |
The primary address prefix. |
string |
provisioningState |
Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. |
string |
routeFilter |
The reference of the RouteFilter resource. |
RouteFilter |
secondaryAzurePort |
The secondary port. |
string |
secondaryPeerAddressPrefix |
The secondary address prefix. |
string |
sharedKey |
The shared key. |
string |
state |
The peering state. |
'Disabled' 'Enabled' |
stats |
Gets peering stats. |
ExpressRouteCircuitStats |
vlanId |
The VLAN ID. |
int |
Name |
Description |
Value |
primarybytesIn |
Gets BytesIn of the peering. |
int |
primarybytesOut |
Gets BytesOut of the peering. |
int |
secondarybytesIn |
Gets BytesIn of the peering. |
int |
secondarybytesOut |
Gets BytesOut of the peering. |
int |
Ipv6ExpressRouteCircuitPeeringConfig
Name |
Description |
Value |
microsoftPeeringConfig |
The Microsoft peering configuration. |
ExpressRouteCircuitPeeringConfig |
primaryPeerAddressPrefix |
The primary address prefix. |
string |
routeFilter |
The reference of the RouteFilter resource. |
RouteFilter |
secondaryPeerAddressPrefix |
The secondary address prefix. |
string |
state |
The state of peering. Possible values are: 'Disabled' and 'Enabled' |
'Disabled' 'Enabled' |
Microsoft.Network/routeFilters
Name |
Description |
Value |
apiVersion |
The api version |
'2018-02-01' |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Route Filter Resource |
RouteFilterPropertiesFormat |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
type |
The resource type |
'Microsoft.Network/routeFilters' |
RouteFilterPropertiesFormat
Name |
Description |
Value |
peerings |
A collection of references to express route circuit peerings. |
ExpressRouteCircuitPeering[] |
rules |
Collection of RouteFilterRules contained within a route filter. |
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 |
Route Filter Rule Resource |
RouteFilterRulePropertiesFormat |
RouteFilterRulePropertiesFormat
Name |
Description |
Value |
access |
The access type of the rule. Valid values are: 'Allow', 'Deny' |
'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. Valid value is: 'Community' |
'Community' (required) |
Name |
Description |
Value |
id |
Resource ID. |
string |
Terraform (AzAPI provider) 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 Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/routeFilters@2018-02-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
peerings = [
{
id = "string"
name = "string"
properties = {
azureASN = int
connections = [
{
id = "string"
name = "string"
properties = {
addressPrefix = "string"
authorizationKey = "string"
expressRouteCircuitPeering = {
id = "string"
}
peerExpressRouteCircuitPeering = {
id = "string"
}
}
}
]
gatewayManagerEtag = "string"
ipv6PeeringConfig = {
microsoftPeeringConfig = {
advertisedCommunities = [
"string"
]
advertisedPublicPrefixes = [
"string"
]
advertisedPublicPrefixesState = "string"
customerASN = int
legacyMode = int
routingRegistryName = "string"
}
primaryPeerAddressPrefix = "string"
routeFilter = {
id = "string"
location = "string"
properties = ...
tags = {
{customized property} = "string"
}
}
secondaryPeerAddressPrefix = "string"
state = "string"
}
lastModifiedBy = "string"
microsoftPeeringConfig = {
advertisedCommunities = [
"string"
]
advertisedPublicPrefixes = [
"string"
]
advertisedPublicPrefixesState = "string"
customerASN = int
legacyMode = int
routingRegistryName = "string"
}
peerASN = int
peeringType = "string"
primaryAzurePort = "string"
primaryPeerAddressPrefix = "string"
provisioningState = "string"
routeFilter = {
id = "string"
location = "string"
properties = ...
tags = {
{customized property} = "string"
}
}
secondaryAzurePort = "string"
secondaryPeerAddressPrefix = "string"
sharedKey = "string"
state = "string"
stats = {
primarybytesIn = int
primarybytesOut = int
secondarybytesIn = int
secondarybytesOut = int
}
vlanId = int
}
}
]
rules = [
{
id = "string"
location = "string"
name = "string"
properties = {
access = "string"
communities = [
"string"
]
routeFilterRuleType = "string"
}
}
]
}
})
tags = {
{customized property} = "string"
}
}
ExpressRouteCircuitConnection
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
|
ExpressRouteCircuitConnectionPropertiesFormat |
ExpressRouteCircuitConnectionPropertiesFormat
Name |
Description |
Value |
addressPrefix |
/29 IP address space to carve out Customer addresses for tunnels. |
string |
authorizationKey |
The authorization key. |
string |
expressRouteCircuitPeering |
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. |
SubResource |
peerExpressRouteCircuitPeering |
Reference to Express Route Circuit Private Peering Resource of the peered circuit. |
SubResource |
ExpressRouteCircuitPeering
Name |
Description |
Value |
id |
Resource ID. |
string |
name |
Gets name of the resource that is unique within a resource group. This name can be used to access the resource. |
string |
properties |
|
ExpressRouteCircuitPeeringPropertiesFormat |
ExpressRouteCircuitPeeringConfig
Name |
Description |
Value |
advertisedCommunities |
The communities of bgp peering. Specified for microsoft peering |
string[] |
advertisedPublicPrefixes |
The reference of AdvertisedPublicPrefixes. |
string[] |
advertisedPublicPrefixesState |
AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. |
'Configured' 'Configuring' 'NotConfigured' 'ValidationNeeded' |
customerASN |
The CustomerASN of the peering. |
int |
legacyMode |
The legacy mode of the peering. |
int |
routingRegistryName |
The RoutingRegistryName of the configuration. |
string |
ExpressRouteCircuitPeeringPropertiesFormat
Name |
Description |
Value |
azureASN |
The Azure ASN. |
int |
connections |
The list of circuit connections associated with Azure Private Peering for this circuit. |
ExpressRouteCircuitConnection[] |
gatewayManagerEtag |
The GatewayManager Etag. |
string |
ipv6PeeringConfig |
The IPv6 peering configuration. |
Ipv6ExpressRouteCircuitPeeringConfig |
lastModifiedBy |
Gets whether the provider or the customer last modified the peering. |
string |
microsoftPeeringConfig |
The Microsoft peering configuration. |
ExpressRouteCircuitPeeringConfig |
peerASN |
The peer ASN. |
int
Constraints: Min value = 1 Max value = 4294967295 |
peeringType |
The peering type. |
'AzurePrivatePeering' 'AzurePublicPeering' 'MicrosoftPeering' |
primaryAzurePort |
The primary port. |
string |
primaryPeerAddressPrefix |
The primary address prefix. |
string |
provisioningState |
Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. |
string |
routeFilter |
The reference of the RouteFilter resource. |
RouteFilter |
secondaryAzurePort |
The secondary port. |
string |
secondaryPeerAddressPrefix |
The secondary address prefix. |
string |
sharedKey |
The shared key. |
string |
state |
The peering state. |
'Disabled' 'Enabled' |
stats |
Gets peering stats. |
ExpressRouteCircuitStats |
vlanId |
The VLAN ID. |
int |
Name |
Description |
Value |
primarybytesIn |
Gets BytesIn of the peering. |
int |
primarybytesOut |
Gets BytesOut of the peering. |
int |
secondarybytesIn |
Gets BytesIn of the peering. |
int |
secondarybytesOut |
Gets BytesOut of the peering. |
int |
Ipv6ExpressRouteCircuitPeeringConfig
Name |
Description |
Value |
microsoftPeeringConfig |
The Microsoft peering configuration. |
ExpressRouteCircuitPeeringConfig |
primaryPeerAddressPrefix |
The primary address prefix. |
string |
routeFilter |
The reference of the RouteFilter resource. |
RouteFilter |
secondaryPeerAddressPrefix |
The secondary address prefix. |
string |
state |
The state of peering. Possible values are: 'Disabled' and 'Enabled' |
'Disabled' 'Enabled' |
Microsoft.Network/routeFilters
Name |
Description |
Value |
location |
Resource location. |
string |
name |
The resource name |
string (required) |
properties |
Route Filter Resource |
RouteFilterPropertiesFormat |
tags |
Resource tags |
Dictionary of tag names and values. |
type |
The resource type |
"Microsoft.Network/routeFilters@2018-02-01" |
RouteFilterPropertiesFormat
Name |
Description |
Value |
peerings |
A collection of references to express route circuit peerings. |
ExpressRouteCircuitPeering[] |
rules |
Collection of RouteFilterRules contained within a route filter. |
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 |
Route Filter Rule Resource |
RouteFilterRulePropertiesFormat |
RouteFilterRulePropertiesFormat
Name |
Description |
Value |
access |
The access type of the rule. Valid values are: 'Allow', 'Deny' |
'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. Valid value is: 'Community' |
'Community' (required) |
Name |
Description |
Value |
id |
Resource ID. |
string |