route_filter_rules

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

Overview

Name	route_filter_rules
Type	Resource
Id	azure.network.route_filter_rules

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting Route Filter Rule resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the route filter rule.

list_by_route_filter

Request successful. The operation returns a list of Route Filter Rule resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the route filter rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, routeFilterName, ruleName, subscriptionId		Gets the specified rule from a route filter.
list_by_route_filter	select	resourceGroupName, routeFilterName, subscriptionId		Gets all RouteFilterRules in a route filter.
create_or_update	insert	resourceGroupName, routeFilterName, ruleName, subscriptionId		Creates or updates a route in the specified route filter.
delete	delete	resourceGroupName, routeFilterName, ruleName, subscriptionId		Deletes the specified rule from a 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
resourceGroupName	string	The name of the resource group.
routeFilterName	string	The name of the route filter.
ruleName	string	The name of the rule.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified rule from a route filter.

SELECT
id,
name,
etag,
location,
properties
FROM azure.network.route_filter_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND routeFilterName = '{{ routeFilterName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_route_filter

Gets all RouteFilterRules in a route filter.

SELECT
id,
name,
etag,
location,
properties
FROM azure.network.route_filter_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND routeFilterName = '{{ routeFilterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a route in the specified route filter.

INSERT INTO azure.network.route_filter_rules (
data__properties,
data__name,
data__location,
data__id,
resourceGroupName,
routeFilterName,
ruleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ location }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ routeFilterName }}',
'{{ ruleName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: route_filter_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the route_filter_rules resource.
    - name: routeFilterName
      value: string
      description: Required parameter for the route_filter_rules resource.
    - name: ruleName
      value: string
      description: Required parameter for the route_filter_rules resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the route_filter_rules resource.
    - name: properties
      value: object
      description: |
        Properties of the route filter rule.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified rule from a route filter.

DELETE FROM azure.network.route_filter_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND routeFilterName = '{{ routeFilterName }}' --required
AND ruleName = '{{ ruleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;