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

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.
access	string	The access type of the rule. Required. Known values are: "Allow" and "Deny". (Allow, Deny)
communities	array	The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. Required.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the route filter rule resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routeFilterRuleType	string	The rule type of the rule. Required. "Community" (Community)

list_by_route_filter

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.
access	string	The access type of the rule. Required. Known values are: "Allow" and "Deny". (Allow, Deny)
communities	array	The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. Required.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the route filter rule resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routeFilterRuleType	string	The rule type of the rule. Required. "Community" (Community)

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, rule_name, subscription_id		Gets the specified rule from a route filter.
list_by_route_filter	select	resource_group_name, route_filter_name, subscription_id		Gets all RouteFilterRules in a route filter.
create_or_update	insert	resource_group_name, route_filter_name, rule_name, subscription_id		Creates or updates a route in the specified route filter.
create_or_update	replace	resource_group_name, route_filter_name, rule_name, subscription_id		Creates or updates a route in the specified route filter.
delete	delete	resource_group_name, route_filter_name, rule_name, subscription_id		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
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.
rule_name	string	The name of the route filter rule. Required.
subscription_id	string

SELECT examples

get

Gets the specified rule from a route filter.

SELECT
id,
name,
access,
communities,
etag,
location,
provisioningState,
routeFilterRuleType
FROM azure.network.route_filter_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND route_filter_name = '{{ route_filter_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_route_filter

Gets all RouteFilterRules in a route filter.

SELECT
id,
name,
access,
communities,
etag,
location,
provisioningState,
routeFilterRuleType
FROM azure.network.route_filter_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND route_filter_name = '{{ route_filter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a route in the specified route filter.

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

Manifest

# Description fields are for documentation purposes
- name: route_filter_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the route_filter_rules resource.
  - name: route_filter_name
    value: "{{ route_filter_name }}"
    description: Required parameter for the route_filter_rules resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the route_filter_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the route_filter_rules resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the route filter rule.
    value:
      access: "{{ access }}"
      routeFilterRuleType: "{{ routeFilterRuleType }}"
      communities:
        - "{{ communities }}"
      provisioningState: "{{ provisioningState }}"
  - name: name
    value: "{{ name }}"
    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: "{{ location }}"
    description: |
      Resource location.

REPLACE examples

create_or_update

Creates or updates a route in the specified route filter.

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

DELETE examples

delete

Deletes the specified rule from a route filter.

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