routes

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

Overview

Name	routes
Type	Resource
Id	azure.network.routes

Fields

vw_routes

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
address_prefix	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
has_bgp_override	text	field from the properties object
next_hop_ip_address	text	field from the properties object
next_hop_type	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
routeName	text	field from the properties object
routeTableName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of the resource.

routes

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, routeName, routeTableName, 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, routeName, routeTableName, subscriptionId	Creates or updates a route in the specified route table.
delete	DELETE	resourceGroupName, routeName, routeTableName, subscriptionId	Deletes the specified route from a route table.

SELECT examples

Gets all routes in a route table.

vw_routes

SELECT
id,
name,
address_prefix,
etag,
has_bgp_override,
next_hop_ip_address,
next_hop_type,
provisioning_state,
resourceGroupName,
routeName,
routeTableName,
subscriptionId,
type
FROM azure.network.vw_routes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND routeTableName = '{{ routeTableName }}'
AND subscriptionId = '{{ subscriptionId }}';

routes

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

INSERT example

Use the following StackQL query and manifest file to create a new routes resource.

All Properties

/*+ create */
INSERT INTO azure.network.routes (
resourceGroupName,
routeName,
routeTableName,
subscriptionId,
properties,
name,
type,
id
)
SELECT 
'{{ resourceGroupName }}',
'{{ routeName }}',
'{{ routeTableName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: addressPrefix
          value: string
        - name: nextHopType
          value: []
        - name: nextHopIpAddress
          value: string
        - name: provisioningState
          value: []
        - name: hasBgpOverride
          value: boolean
    - name: name
      value: string
    - name: etag
      value: string
    - name: type
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified routes resource.

/*+ delete */
DELETE FROM azure.network.routes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND routeName = '{{ routeName }}'
AND routeTableName = '{{ routeTableName }}'
AND subscriptionId = '{{ subscriptionId }}';