hub_route_tables

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

Overview

Name	hub_route_tables
Type	Resource
Id	azure.network.hub_route_tables

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
associatedConnections	array	List of all connections associated with this route table.
etag	string	A unique read-only string that changes whenever the resource is updated.
labels	array	List of labels associated with this route table.
propagatingConnections	array	List of all connections that advertise to this route table.
provisioningState	string	The provisioning state of the RouteTable resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routes	array	List of all routes.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
associatedConnections	array	List of all connections associated with this route table.
etag	string	A unique read-only string that changes whenever the resource is updated.
labels	array	List of labels associated with this route table.
propagatingConnections	array	List of all connections that advertise to this route table.
provisioningState	string	The provisioning state of the RouteTable resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routes	array	List of all routes.
type	string	Resource type.

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_table_name, subscription_id		Retrieves the details of a RouteTable.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all RouteTables.
create_or_update	insert	resource_group_name, virtual_hub_name, route_table_name, subscription_id		Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.
create_or_update	replace	resource_group_name, virtual_hub_name, route_table_name, subscription_id		Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.
delete	delete	resource_group_name, virtual_hub_name, route_table_name, subscription_id		Deletes a RouteTable.

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_table_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 RouteTable.

SELECT
id,
name,
associatedConnections,
etag,
labels,
propagatingConnections,
provisioningState,
routes,
type
FROM azure.network.hub_route_tables
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND route_table_name = '{{ route_table_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves the details of all RouteTables.

SELECT
id,
name,
associatedConnections,
etag,
labels,
propagatingConnections,
provisioningState,
routes,
type
FROM azure.network.hub_route_tables
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 RouteTable resource if it doesn't exist else updates the existing RouteTable.

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

Manifest

# Description fields are for documentation purposes
- name: hub_route_tables
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hub_route_tables resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the hub_route_tables resource.
  - name: route_table_name
    value: "{{ route_table_name }}"
    description: Required parameter for the hub_route_tables resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hub_route_tables resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the RouteTable resource.
    value:
      routes:
        - name: "{{ name }}"
          destinationType: "{{ destinationType }}"
          destinations: "{{ destinations }}"
          nextHopType: "{{ nextHopType }}"
          nextHop: "{{ nextHop }}"
      labels:
        - "{{ labels }}"
      associatedConnections:
        - "{{ associatedConnections }}"
      propagatingConnections:
        - "{{ propagatingConnections }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.

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

DELETE examples

delete

Deletes a RouteTable.

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