route_policies

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

Overview

Name	route_policies
Type	Resource
Id	azure.managed_network_fabric.route_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Lists all RoutePolicies under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_subscription

Lists all RoutePolicies under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, routePolicyName		Implements Route Policy GET method.
list_by_resource_group	select	subscriptionId, resourceGroupName		Implements RoutePolicies list by resource group GET method.
list_by_subscription	select	subscriptionId		Implements RoutePolicies list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, routePolicyName, data__location, data__properties		Implements Route Policy PUT method.
update	update	subscriptionId, resourceGroupName, routePolicyName		API to update certain properties of the Route Policy resource.
delete	delete	subscriptionId, resourceGroupName, routePolicyName		Implements Route Policy DELETE method.
validate_configuration	exec	subscriptionId, resourceGroupName, routePolicyName		Validates the configuration of the resources.
commit_configuration	exec	subscriptionId, resourceGroupName, routePolicyName		Commits the configuration of the given resources.

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. The name is case insensitive.
routePolicyName	string	Name of the Route Policy.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Implements Route Policy GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.route_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND routePolicyName = '{{ routePolicyName }}' -- required
;

list_by_resource_group

Implements RoutePolicies list by resource group GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.route_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Implements RoutePolicies list by subscription GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.route_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Implements Route Policy PUT method.

INSERT INTO azure.managed_network_fabric.route_policies (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
routePolicyName
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ routePolicyName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: route_policies
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the route_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the route_policies resource.
    - name: routePolicyName
      value: string
      description: Required parameter for the route_policies resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

API to update certain properties of the Route Policy resource.

UPDATE azure.managed_network_fabric.route_policies
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND routePolicyName = '{{ routePolicyName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Implements Route Policy DELETE method.

DELETE FROM azure.managed_network_fabric.route_policies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND routePolicyName = '{{ routePolicyName }}' --required
;

Lifecycle Methods

validate_configuration

Validates the configuration of the resources.

EXEC azure.managed_network_fabric.route_policies.validate_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@routePolicyName='{{ routePolicyName }}' --required
;

commit_configuration

Commits the configuration of the given resources.

EXEC azure.managed_network_fabric.route_policies.commit_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@routePolicyName='{{ routePolicyName }}' --required
;