route_filters

Creates, updates, deletes, gets or lists a route_filters resource.

Overview

Name	route_filters
Type	Resource
Id	azure.network.route_filters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipv6Peerings	array	A collection of references to express route circuit ipv6 peerings.
location	string	Resource location.
peerings	array	A collection of references to express route circuit peerings.
provisioningState	string	The provisioning state of the route filter resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rules	array	Collection of RouteFilterRules contained within a route filter.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipv6Peerings	array	A collection of references to express route circuit ipv6 peerings.
location	string	Resource location.
peerings	array	A collection of references to express route circuit peerings.
provisioningState	string	The provisioning state of the route filter resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rules	array	Collection of RouteFilterRules contained within a route filter.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipv6Peerings	array	A collection of references to express route circuit ipv6 peerings.
location	string	Resource location.
peerings	array	A collection of references to express route circuit peerings.
provisioningState	string	The provisioning state of the route filter resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rules	array	Collection of RouteFilterRules contained within a route filter.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, route_filter_name, subscription_id	$expand	Gets the specified route filter.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all route filters in a resource group.
list	select	subscription_id		Gets all route filters in a subscription.
create_or_update	insert	resource_group_name, route_filter_name, subscription_id		Creates or updates a route filter in a specified resource group.
update_tags	update	resource_group_name, route_filter_name, subscription_id		Updates tags of a route filter.
create_or_update	replace	resource_group_name, route_filter_name, subscription_id		Creates or updates a route filter in a specified resource group.
delete	delete	resource_group_name, route_filter_name, subscription_id		Deletes the specified route filter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
route_filter_name	string	The name of the route filter. Required.
subscription_id	string
$expand	string	Expands referenced express route bgp peering resources. Default value is None.

SELECT examples

get

Gets the specified route filter.

SELECT
id,
name,
etag,
ipv6Peerings,
location,
peerings,
provisioningState,
rules,
tags,
type
FROM azure.network.route_filters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND route_filter_name = '{{ route_filter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all route filters in a resource group.

SELECT
id,
name,
etag,
ipv6Peerings,
location,
peerings,
provisioningState,
rules,
tags,
type
FROM azure.network.route_filters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all route filters in a subscription.

SELECT
id,
name,
etag,
ipv6Peerings,
location,
peerings,
provisioningState,
rules,
tags,
type
FROM azure.network.route_filters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a route filter in a specified resource group.

INSERT INTO azure.network.route_filters (
id,
location,
tags,
properties,
resource_group_name,
route_filter_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ route_filter_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: route_filters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the route_filters resource.
  - name: route_filter_name
    value: "{{ route_filter_name }}"
    description: Required parameter for the route_filters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the route_filters resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the route filter.
    value:
      rules:
        - id: "{{ id }}"
          properties:
            access: "{{ access }}"
            routeFilterRuleType: "{{ routeFilterRuleType }}"
            communities:
              - "{{ communities }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          location: "{{ location }}"
          etag: "{{ etag }}"
      peerings:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            peeringType: "{{ peeringType }}"
            state: "{{ state }}"
            azureASN: {{ azureASN }}
            peerASN: {{ peerASN }}
            primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
            secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
            primaryAzurePort: "{{ primaryAzurePort }}"
            secondaryAzurePort: "{{ secondaryAzurePort }}"
            sharedKey: "{{ sharedKey }}"
            vlanId: {{ vlanId }}
            microsoftPeeringConfig:
              advertisedPublicPrefixes:
                - "{{ advertisedPublicPrefixes }}"
              advertisedCommunities:
                - "{{ advertisedCommunities }}"
              advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
              legacyMode: {{ legacyMode }}
              customerASN: {{ customerASN }}
              routingRegistryName: "{{ routingRegistryName }}"
              advertisedPublicPrefixInfo:
                - prefix: "{{ prefix }}"
                  validationId: "{{ validationId }}"
                  signature: "{{ signature }}"
                  validationState: "{{ validationState }}"
            stats:
              primarybytesIn: {{ primarybytesIn }}
              primarybytesOut: {{ primarybytesOut }}
              secondarybytesIn: {{ secondarybytesIn }}
              secondarybytesOut: {{ secondarybytesOut }}
            provisioningState: "{{ provisioningState }}"
            gatewayManagerEtag: "{{ gatewayManagerEtag }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            routeFilter:
              id: "{{ id }}"
            ipv6PeeringConfig:
              primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
              secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
              microsoftPeeringConfig:
                advertisedPublicPrefixes: "{{ advertisedPublicPrefixes }}"
                advertisedCommunities: "{{ advertisedCommunities }}"
                advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
                legacyMode: {{ legacyMode }}
                customerASN: {{ customerASN }}
                routingRegistryName: "{{ routingRegistryName }}"
                advertisedPublicPrefixInfo: "{{ advertisedPublicPrefixInfo }}"
              routeFilter:
                id: "{{ id }}"
              state: "{{ state }}"
            expressRouteConnection:
              id: "{{ id }}"
            connections:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  expressRouteCircuitPeering: "{{ expressRouteCircuitPeering }}"
                  peerExpressRouteCircuitPeering: "{{ peerExpressRouteCircuitPeering }}"
                  addressPrefix: "{{ addressPrefix }}"
                  authorizationKey: "{{ authorizationKey }}"
                  ipv6CircuitConnectionConfig: "{{ ipv6CircuitConnectionConfig }}"
                  circuitConnectionStatus: "{{ circuitConnectionStatus }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            peeredConnections:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  expressRouteCircuitPeering: "{{ expressRouteCircuitPeering }}"
                  peerExpressRouteCircuitPeering: "{{ peerExpressRouteCircuitPeering }}"
                  addressPrefix: "{{ addressPrefix }}"
                  circuitConnectionStatus: "{{ circuitConnectionStatus }}"
                  connectionName: "{{ connectionName }}"
                  authResourceGuid: "{{ authResourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
          etag: "{{ etag }}"
      ipv6Peerings:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            peeringType: "{{ peeringType }}"
            state: "{{ state }}"
            azureASN: {{ azureASN }}
            peerASN: {{ peerASN }}
            primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
            secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
            primaryAzurePort: "{{ primaryAzurePort }}"
            secondaryAzurePort: "{{ secondaryAzurePort }}"
            sharedKey: "{{ sharedKey }}"
            vlanId: {{ vlanId }}
            microsoftPeeringConfig:
              advertisedPublicPrefixes:
                - "{{ advertisedPublicPrefixes }}"
              advertisedCommunities:
                - "{{ advertisedCommunities }}"
              advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
              legacyMode: {{ legacyMode }}
              customerASN: {{ customerASN }}
              routingRegistryName: "{{ routingRegistryName }}"
              advertisedPublicPrefixInfo:
                - prefix: "{{ prefix }}"
                  validationId: "{{ validationId }}"
                  signature: "{{ signature }}"
                  validationState: "{{ validationState }}"
            stats:
              primarybytesIn: {{ primarybytesIn }}
              primarybytesOut: {{ primarybytesOut }}
              secondarybytesIn: {{ secondarybytesIn }}
              secondarybytesOut: {{ secondarybytesOut }}
            provisioningState: "{{ provisioningState }}"
            gatewayManagerEtag: "{{ gatewayManagerEtag }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            routeFilter:
              id: "{{ id }}"
            ipv6PeeringConfig:
              primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
              secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
              microsoftPeeringConfig:
                advertisedPublicPrefixes: "{{ advertisedPublicPrefixes }}"
                advertisedCommunities: "{{ advertisedCommunities }}"
                advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
                legacyMode: {{ legacyMode }}
                customerASN: {{ customerASN }}
                routingRegistryName: "{{ routingRegistryName }}"
                advertisedPublicPrefixInfo: "{{ advertisedPublicPrefixInfo }}"
              routeFilter:
                id: "{{ id }}"
              state: "{{ state }}"
            expressRouteConnection:
              id: "{{ id }}"
            connections:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  expressRouteCircuitPeering: "{{ expressRouteCircuitPeering }}"
                  peerExpressRouteCircuitPeering: "{{ peerExpressRouteCircuitPeering }}"
                  addressPrefix: "{{ addressPrefix }}"
                  authorizationKey: "{{ authorizationKey }}"
                  ipv6CircuitConnectionConfig: "{{ ipv6CircuitConnectionConfig }}"
                  circuitConnectionStatus: "{{ circuitConnectionStatus }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            peeredConnections:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  expressRouteCircuitPeering: "{{ expressRouteCircuitPeering }}"
                  peerExpressRouteCircuitPeering: "{{ peerExpressRouteCircuitPeering }}"
                  addressPrefix: "{{ addressPrefix }}"
                  circuitConnectionStatus: "{{ circuitConnectionStatus }}"
                  connectionName: "{{ connectionName }}"
                  authResourceGuid: "{{ authResourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
          etag: "{{ etag }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update_tags

Updates tags of a route filter.

UPDATE azure.network.route_filters
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND route_filter_name = '{{ route_filter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a route filter in a specified resource group.

REPLACE azure.network.route_filters
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND route_filter_name = '{{ route_filter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified route filter.

DELETE FROM azure.network.route_filters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND route_filter_name = '{{ route_filter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;