routes

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

Overview

Name	routes
Type	Resource
Id	azure.network.routes

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting Route resource.

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 route.
type	string	The type of the resource.

list

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

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 route.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, routeTableName, routeName, subscriptionId		Gets the specified route from a route table.
list	select	resourceGroupName, routeTableName, subscriptionId		Gets all routes in a route table.
create_or_update	insert	resourceGroupName, routeTableName, routeName, subscriptionId		Creates or updates a route in the specified route table.
delete	delete	resourceGroupName, routeTableName, routeName, subscriptionId		Deletes the specified route from a route table.

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.
routeName	string	The name of the route.
routeTableName	string	The name of the route table.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified route from a route table.

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

list

Gets all routes in a route table.

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

INSERT examples

create_or_update

Creates or updates a route in the specified route table.

INSERT INTO azure.network.routes (
data__properties,
data__name,
data__type,
data__id,
resourceGroupName,
routeTableName,
routeName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ routeTableName }}',
'{{ routeName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: routes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the routes resource.
    - name: routeTableName
      value: string
      description: Required parameter for the routes resource.
    - name: routeName
      value: string
      description: Required parameter for the routes resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the routes resource.
    - name: properties
      value: object
      description: |
        Properties of the route.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: type
      value: string
      description: |
        The type of the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified route from a route table.

DELETE FROM azure.network.routes
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND routeTableName = '{{ routeTableName }}' --required
AND routeName = '{{ routeName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;