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

vw_route_filter_rules

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
access	text	field from the properties object
communities	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
location	text	Resource location.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
routeFilterName	text	field from the properties object
route_filter_rule_type	text	field from the properties object
ruleName	text	field from the properties object
subscriptionId	text	field from the properties object

route_filter_rules

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	Route Filter Rule Resource.

Methods

Name	Accessible by	Required 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.

SELECT examples

Gets all RouteFilterRules in a route filter.

vw_route_filter_rules

SELECT
id,
name,
access,
communities,
etag,
location,
provisioning_state,
resourceGroupName,
routeFilterName,
route_filter_rule_type,
ruleName,
subscriptionId
FROM azure.network.vw_route_filter_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND routeFilterName = '{{ routeFilterName }}'
AND subscriptionId = '{{ subscriptionId }}';

route_filter_rules

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

INSERT example

Use the following StackQL query and manifest file to create a new route_filter_rules resource.

All Properties

/*+ create */
INSERT INTO azure.network.route_filter_rules (
resourceGroupName,
routeFilterName,
ruleName,
subscriptionId,
properties,
name,
location,
id
)
SELECT 
'{{ resourceGroupName }}',
'{{ routeFilterName }}',
'{{ ruleName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ name }}',
'{{ location }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: access
          value: []
        - name: routeFilterRuleType
          value: string
        - name: communities
          value:
            - string
        - name: provisioningState
          value: []
    - name: name
      value: string
    - name: location
      value: string
    - name: etag
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified route_filter_rules resource.

/*+ delete */
DELETE FROM azure.network.route_filter_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND routeFilterName = '{{ routeFilterName }}'
AND ruleName = '{{ ruleName }}'
AND subscriptionId = '{{ subscriptionId }}';