route_tables

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

Overview

Name	route_tables
Type	Resource
Id	azure.network.route_tables

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting RouteTable resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the route table.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the route table.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_all

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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the route table.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, routeTableName, subscriptionId	$expand	Gets the specified route table.
list	select	resourceGroupName, subscriptionId		Gets all route tables in a resource group.
list_all	select	subscriptionId		Gets all route tables in a subscription.
create_or_update	insert	resourceGroupName, routeTableName, subscriptionId		Create or updates a route table in a specified resource group.
delete	delete	resourceGroupName, routeTableName, subscriptionId		Deletes the specified route table.
update_tags	exec	resourceGroupName, routeTableName, subscriptionId		Updates a route table tags.

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

SELECT examples

get

Gets the specified route table.

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

list

Gets all route tables in a resource group.

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

list_all

Gets all route tables in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.route_tables
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or updates a route table in a specified resource group.

INSERT INTO azure.network.route_tables (
data__properties,
resourceGroupName,
routeTableName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ routeTableName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: route_tables
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the route_tables resource.
    - name: routeTableName
      value: string
      description: Required parameter for the route_tables resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the route_tables resource.
    - name: properties
      value: object
      description: |
        Properties of the route table.

DELETE examples

delete

Deletes the specified route table.

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

Lifecycle Methods

update_tags

Updates a route table tags.

EXEC azure.network.route_tables.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@routeTableName='{{ routeTableName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;