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

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the route filter.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the route filter.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the route filter.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, routeFilterName, subscriptionId	$expand	Gets the specified route filter.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all route filters in a resource group.
list	select	subscriptionId		Gets all route filters in a subscription.
create_or_update	insert	resourceGroupName, routeFilterName, subscriptionId, data__location		Creates or updates a route filter in a specified resource group.
delete	delete	resourceGroupName, routeFilterName, subscriptionId		Deletes the specified route filter.
update_tags	exec	resourceGroupName, routeFilterName, subscriptionId		Updates tags of 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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced express route bgp peering resources.

SELECT examples

get

Gets the specified route filter.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.route_filters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND routeFilterName = '{{ routeFilterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all route filters in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.route_filters
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all route filters in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.route_filters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.network.route_filters (
data__properties,
resourceGroupName,
routeFilterName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ routeFilterName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: route_filters
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the route_filters resource.
    - name: routeFilterName
      value: string
      description: Required parameter for the route_filters resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the route_filters resource.
    - name: properties
      value: object
      description: |
        Properties of the route filter.

DELETE examples

delete

Deletes the specified route filter.

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

Lifecycle Methods

update_tags

Updates tags of a route filter.

EXEC azure.network.route_filters.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@routeFilterName='{{ routeFilterName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;