route_maps

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

Overview

Name	route_maps
Type	Resource
Id	azure.network.route_maps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
associatedInboundConnections	array	List of connections which have this RoutMap associated for inbound traffic.
associatedOutboundConnections	array	List of connections which have this RoutMap associated for outbound traffic.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the RouteMap resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rules	array	List of RouteMap rules to be applied.
type	string	Type of the resource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
associatedInboundConnections	array	List of connections which have this RoutMap associated for inbound traffic.
associatedOutboundConnections	array	List of connections which have this RoutMap associated for outbound traffic.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the RouteMap resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rules	array	List of RouteMap rules to be applied.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_hub_name, route_map_name, subscription_id		Retrieves the details of a RouteMap.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all RouteMaps.
create_or_update	insert	resource_group_name, virtual_hub_name, route_map_name, subscription_id		Creates a RouteMap if it doesn't exist else updates the existing one.
create_or_update	replace	resource_group_name, virtual_hub_name, route_map_name, subscription_id		Creates a RouteMap if it doesn't exist else updates the existing one.
delete	delete	resource_group_name, virtual_hub_name, route_map_name, subscription_id		Deletes a RouteMap.

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_map_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
subscription_id	string
virtual_hub_name	string	The name of the VirtualHub. Required.

SELECT examples

get

Retrieves the details of a RouteMap.

SELECT
id,
name,
associatedInboundConnections,
associatedOutboundConnections,
etag,
provisioningState,
rules,
type
FROM azure.network.route_maps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND route_map_name = '{{ route_map_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves the details of all RouteMaps.

SELECT
id,
name,
associatedInboundConnections,
associatedOutboundConnections,
etag,
provisioningState,
rules,
type
FROM azure.network.route_maps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a RouteMap if it doesn't exist else updates the existing one.

INSERT INTO azure.network.route_maps (
properties,
resource_group_name,
virtual_hub_name,
route_map_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_hub_name }}',
'{{ route_map_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: route_maps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the route_maps resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the route_maps resource.
  - name: route_map_name
    value: "{{ route_map_name }}"
    description: Required parameter for the route_maps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the route_maps resource.
  - name: properties
    description: |
      Properties of the RouteMap resource.
    value:
      associatedInboundConnections:
        - "{{ associatedInboundConnections }}"
      associatedOutboundConnections:
        - "{{ associatedOutboundConnections }}"
      rules:
        - name: "{{ name }}"
          matchCriteria: "{{ matchCriteria }}"
          actions: "{{ actions }}"
          nextStepIfMatched: "{{ nextStepIfMatched }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates a RouteMap if it doesn't exist else updates the existing one.

REPLACE azure.network.route_maps
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND route_map_name = '{{ route_map_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a RouteMap.

DELETE FROM azure.network.route_maps
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND route_map_name = '{{ route_map_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;