Microsoft.Network routeFilters 2019-08-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 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@2019-08-01' = {
  location: 'string'
  name: 'string'
  properties: {
    ipv6Peerings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          azureASN: int
          connections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                addressPrefix: 'string'
                authorizationKey: 'string'
                expressRouteCircuitPeering: {
                  id: 'string'
                }
                peerExpressRouteCircuitPeering: {
                  id: 'string'
                }
              }
            }
          ]
          expressRouteConnection: {}
          gatewayManagerEtag: 'string'
          ipv6PeeringConfig: {
            microsoftPeeringConfig: {
              advertisedCommunities: [
                'string'
              ]
              advertisedPublicPrefixes: [
                'string'
              ]
              advertisedPublicPrefixesState: 'string'
              customerASN: int
              legacyMode: int
              routingRegistryName: 'string'
            }
            primaryPeerAddressPrefix: 'string'
            routeFilter: {
              id: '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'
          routeFilter: {
            id: 'string'
          }
          secondaryAzurePort: 'string'
          secondaryPeerAddressPrefix: 'string'
          sharedKey: 'string'
          state: 'string'
          stats: {
            primarybytesIn: int
            primarybytesOut: int
            secondarybytesIn: int
            secondarybytesOut: int
          }
          vlanId: int
        }
      }
    ]
    peerings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          azureASN: int
          connections: [
            {
              id: 'string'
              name: 'string'
              properties: {
                addressPrefix: 'string'
                authorizationKey: 'string'
                expressRouteCircuitPeering: {
                  id: 'string'
                }
                peerExpressRouteCircuitPeering: {
                  id: 'string'
                }
              }
            }
          ]
          expressRouteConnection: {}
          gatewayManagerEtag: 'string'
          ipv6PeeringConfig: {
            microsoftPeeringConfig: {
              advertisedCommunities: [
                'string'
              ]
              advertisedPublicPrefixes: [
                'string'
              ]
              advertisedPublicPrefixesState: 'string'
              customerASN: int
              legacyMode: int
              routingRegistryName: 'string'
            }
            primaryPeerAddressPrefix: 'string'
            routeFilter: {
              id: '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'
          routeFilter: {
            id: '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'
  }
}

Property values

ExpressRouteCircuitConnection

Name	Description	Value
id	Resource ID.	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 express route circuit connection.	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	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 express route circuit peering.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference of AdvertisedPublicPrefixes.	string[]
advertisedPublicPrefixesState	The advertised public prefix state of the Peering resource.	'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[]
expressRouteConnection	The ExpressRoute connection.	ExpressRouteConnectionId
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
lastModifiedBy	Who was the last to modify 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
routeFilter	The reference of the RouteFilter resource.	SubResource
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
stats	The peering stats of express route circuit.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitStats

Name	Description	Value
primarybytesIn	The Primary BytesIn of the peering.	int
primarybytesOut	The primary BytesOut of the peering.	int
secondarybytesIn	The secondary BytesIn of the peering.	int
secondarybytesOut	The secondary BytesOut of the peering.	int

ExpressRouteConnectionId

Name	Description	Value

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference of the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

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

ResourceTags

Name	Description	Value

RouteFilterPropertiesFormat

Name	Description	Value
ipv6Peerings	A collection of references to express route circuit ipv6 peerings.	ExpressRouteCircuitPeering[]
peerings	A collection of references to express route circuit peerings.	ExpressRouteCircuitPeering[]
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)

SubResource

Name	Description	Value
id	Resource ID.	string

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": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "ipv6Peerings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "azureASN": "int",
          "connections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "addressPrefix": "string",
                "authorizationKey": "string",
                "expressRouteCircuitPeering": {
                  "id": "string"
                },
                "peerExpressRouteCircuitPeering": {
                  "id": "string"
                }
              }
            }
          ],
          "expressRouteConnection": {
          },
          "gatewayManagerEtag": "string",
          "ipv6PeeringConfig": {
            "microsoftPeeringConfig": {
              "advertisedCommunities": [ "string" ],
              "advertisedPublicPrefixes": [ "string" ],
              "advertisedPublicPrefixesState": "string",
              "customerASN": "int",
              "legacyMode": "int",
              "routingRegistryName": "string"
            },
            "primaryPeerAddressPrefix": "string",
            "routeFilter": {
              "id": "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",
          "routeFilter": {
            "id": "string"
          },
          "secondaryAzurePort": "string",
          "secondaryPeerAddressPrefix": "string",
          "sharedKey": "string",
          "state": "string",
          "stats": {
            "primarybytesIn": "int",
            "primarybytesOut": "int",
            "secondarybytesIn": "int",
            "secondarybytesOut": "int"
          },
          "vlanId": "int"
        }
      }
    ],
    "peerings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "azureASN": "int",
          "connections": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "addressPrefix": "string",
                "authorizationKey": "string",
                "expressRouteCircuitPeering": {
                  "id": "string"
                },
                "peerExpressRouteCircuitPeering": {
                  "id": "string"
                }
              }
            }
          ],
          "expressRouteConnection": {
          },
          "gatewayManagerEtag": "string",
          "ipv6PeeringConfig": {
            "microsoftPeeringConfig": {
              "advertisedCommunities": [ "string" ],
              "advertisedPublicPrefixes": [ "string" ],
              "advertisedPublicPrefixesState": "string",
              "customerASN": "int",
              "legacyMode": "int",
              "routingRegistryName": "string"
            },
            "primaryPeerAddressPrefix": "string",
            "routeFilter": {
              "id": "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",
          "routeFilter": {
            "id": "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"
  }
}

Property values

ExpressRouteCircuitConnection

Name	Description	Value
id	Resource ID.	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 express route circuit connection.	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	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 express route circuit peering.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference of AdvertisedPublicPrefixes.	string[]
advertisedPublicPrefixesState	The advertised public prefix state of the Peering resource.	'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[]
expressRouteConnection	The ExpressRoute connection.	ExpressRouteConnectionId
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
lastModifiedBy	Who was the last to modify 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
routeFilter	The reference of the RouteFilter resource.	SubResource
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
stats	The peering stats of express route circuit.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitStats

Name	Description	Value
primarybytesIn	The Primary BytesIn of the peering.	int
primarybytesOut	The primary BytesOut of the peering.	int
secondarybytesIn	The secondary BytesIn of the peering.	int
secondarybytesOut	The secondary BytesOut of the peering.	int

ExpressRouteConnectionId

Name	Description	Value

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference of the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

Microsoft.Network/routeFilters

Name	Description	Value
apiVersion	The api version	'2019-08-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'

ResourceTags

Name	Description	Value

RouteFilterPropertiesFormat

Name	Description	Value
ipv6Peerings	A collection of references to express route circuit ipv6 peerings.	ExpressRouteCircuitPeering[]
peerings	A collection of references to express route circuit peerings.	ExpressRouteCircuitPeering[]
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)

SubResource

Name	Description	Value
id	Resource ID.	string

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@2019-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      ipv6Peerings = [
        {
          id = "string"
          name = "string"
          properties = {
            azureASN = int
            connections = [
              {
                id = "string"
                name = "string"
                properties = {
                  addressPrefix = "string"
                  authorizationKey = "string"
                  expressRouteCircuitPeering = {
                    id = "string"
                  }
                  peerExpressRouteCircuitPeering = {
                    id = "string"
                  }
                }
              }
            ]
            expressRouteConnection = {
            }
            gatewayManagerEtag = "string"
            ipv6PeeringConfig = {
              microsoftPeeringConfig = {
                advertisedCommunities = [
                  "string"
                ]
                advertisedPublicPrefixes = [
                  "string"
                ]
                advertisedPublicPrefixesState = "string"
                customerASN = int
                legacyMode = int
                routingRegistryName = "string"
              }
              primaryPeerAddressPrefix = "string"
              routeFilter = {
                id = "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"
            routeFilter = {
              id = "string"
            }
            secondaryAzurePort = "string"
            secondaryPeerAddressPrefix = "string"
            sharedKey = "string"
            state = "string"
            stats = {
              primarybytesIn = int
              primarybytesOut = int
              secondarybytesIn = int
              secondarybytesOut = int
            }
            vlanId = int
          }
        }
      ]
      peerings = [
        {
          id = "string"
          name = "string"
          properties = {
            azureASN = int
            connections = [
              {
                id = "string"
                name = "string"
                properties = {
                  addressPrefix = "string"
                  authorizationKey = "string"
                  expressRouteCircuitPeering = {
                    id = "string"
                  }
                  peerExpressRouteCircuitPeering = {
                    id = "string"
                  }
                }
              }
            ]
            expressRouteConnection = {
            }
            gatewayManagerEtag = "string"
            ipv6PeeringConfig = {
              microsoftPeeringConfig = {
                advertisedCommunities = [
                  "string"
                ]
                advertisedPublicPrefixes = [
                  "string"
                ]
                advertisedPublicPrefixesState = "string"
                customerASN = int
                legacyMode = int
                routingRegistryName = "string"
              }
              primaryPeerAddressPrefix = "string"
              routeFilter = {
                id = "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"
            routeFilter = {
              id = "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"
          }
        }
      ]
    }
  })
}

Property values

ExpressRouteCircuitConnection

Name	Description	Value
id	Resource ID.	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 express route circuit connection.	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	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 express route circuit peering.	ExpressRouteCircuitPeeringPropertiesFormat

ExpressRouteCircuitPeeringConfig

Name	Description	Value
advertisedCommunities	The communities of bgp peering. Specified for microsoft peering.	string[]
advertisedPublicPrefixes	The reference of AdvertisedPublicPrefixes.	string[]
advertisedPublicPrefixesState	The advertised public prefix state of the Peering resource.	'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[]
expressRouteConnection	The ExpressRoute connection.	ExpressRouteConnectionId
gatewayManagerEtag	The GatewayManager Etag.	string
ipv6PeeringConfig	The IPv6 peering configuration.	Ipv6ExpressRouteCircuitPeeringConfig
lastModifiedBy	Who was the last to modify 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
routeFilter	The reference of the RouteFilter resource.	SubResource
secondaryAzurePort	The secondary port.	string
secondaryPeerAddressPrefix	The secondary address prefix.	string
sharedKey	The shared key.	string
state	The peering state.	'Disabled' 'Enabled'
stats	The peering stats of express route circuit.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitStats

Name	Description	Value
primarybytesIn	The Primary BytesIn of the peering.	int
primarybytesOut	The primary BytesOut of the peering.	int
secondarybytesIn	The secondary BytesIn of the peering.	int
secondarybytesOut	The secondary BytesOut of the peering.	int

ExpressRouteConnectionId

Name	Description	Value

Ipv6ExpressRouteCircuitPeeringConfig

Name	Description	Value
microsoftPeeringConfig	The Microsoft peering configuration.	ExpressRouteCircuitPeeringConfig
primaryPeerAddressPrefix	The primary address prefix.	string
routeFilter	The reference of the RouteFilter resource.	SubResource
secondaryPeerAddressPrefix	The secondary address prefix.	string
state	The state of peering.	'Disabled' 'Enabled'

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@2019-08-01"

ResourceTags

Name	Description	Value

RouteFilterPropertiesFormat

Name	Description	Value
ipv6Peerings	A collection of references to express route circuit ipv6 peerings.	ExpressRouteCircuitPeering[]
peerings	A collection of references to express route circuit peerings.	ExpressRouteCircuitPeering[]
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)

SubResource

Name	Description	Value
id	Resource ID.	string