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

Request successful. Returns the details of the RouteMap retrieved.

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.
properties	object	Properties of the RouteMap resource.
type	string	Resource type.

list

Request successful. Returns the details of all the RouteMaps for the VirtualHub.

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.
properties	object	Properties of the RouteMap resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualHubName, routeMapName		Retrieves the details of a RouteMap.
list	select	subscriptionId, resourceGroupName, virtualHubName		Retrieves the details of all RouteMaps.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHubName, routeMapName		Creates a RouteMap if it doesn't exist else updates the existing one.
delete	delete	subscriptionId, resourceGroupName, virtualHubName, routeMapName		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
resourceGroupName	string	The resource group name of the RouteMap's resource group.
routeMapName	string	The name of the RouteMap.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	string	The name of the VirtualHub containing the RouteMap.

SELECT examples

get

Retrieves the details of a RouteMap.

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

list

Retrieves the details of all RouteMaps.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.route_maps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- 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 (
data__properties,
data__id,
subscriptionId,
resourceGroupName,
virtualHubName,
routeMapName
)
SELECT 
'{{ properties }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualHubName }}',
'{{ routeMapName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: route_maps
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the route_maps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the route_maps resource.
    - name: virtualHubName
      value: string
      description: Required parameter for the route_maps resource.
    - name: routeMapName
      value: string
      description: Required parameter for the route_maps resource.
    - name: properties
      value: object
      description: |
        Properties of the RouteMap resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a RouteMap.

DELETE FROM azure.network.route_maps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualHubName = '{{ virtualHubName }}' --required
AND routeMapName = '{{ routeMapName }}' --required
;