Microsoft.Network routeFilters 2017-09-01

• Latest
• 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@2017-09-01' = {
  location: 'string'
  name: 'string'
  properties: {
    peerings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          azureASN: int
          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'
        }
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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
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
peeringType	The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.	'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 state of peering. Possible values are: 'Disabled' and 'Enabled'	'Disabled' 'Enabled'
stats	Gets peering stats.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitStats

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

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

RouteFilter

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Route Filter Resource	RouteFilterPropertiesFormat
tags	Resource tags.	ResourceTags

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[]

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
tags	Resource tags.	RouteFilterRuleTags

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)

RouteFilterRuleTags

Name	Description	Value

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": "2017-09-01",
  "name": "string",
  "location": "string",
  "properties": {
    "peerings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "azureASN": "int",
          "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"
        }
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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
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
peeringType	The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.	'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 state of peering. Possible values are: 'Disabled' and 'Enabled'	'Disabled' 'Enabled'
stats	Gets peering stats.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitStats

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	'2017-09-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'

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

RouteFilter

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Route Filter Resource	RouteFilterPropertiesFormat
tags	Resource tags.	ResourceTags

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[]

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
tags	Resource tags.	RouteFilterRuleTags

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)

RouteFilterRuleTags

Name	Description	Value

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@2017-09-01"
  name = "string"
  location = "string"
  body = jsonencode({
    properties = {
      peerings = [
        {
          id = "string"
          name = "string"
          properties = {
            azureASN = int
            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"
          }
        }
      ]
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

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
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
peeringType	The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.	'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 state of peering. Possible values are: 'Disabled' and 'Enabled'	'Disabled' 'Enabled'
stats	Gets peering stats.	ExpressRouteCircuitStats
vlanId	The VLAN ID.	int

ExpressRouteCircuitStats

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@2017-09-01"

ResourceTags

Name	Description	Value

ResourceTags

Name	Description	Value

RouteFilter

Name	Description	Value
id	Resource ID.	string
location	Resource location.	string
properties	Route Filter Resource	RouteFilterPropertiesFormat
tags	Resource tags.	ResourceTags

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[]

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
tags	Resource tags.	RouteFilterRuleTags

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)

RouteFilterRuleTags

Name	Description	Value