virtual_hub_route_table_v2s

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

Overview

Name	virtual_hub_route_table_v2s
Type	Resource
Id	azure.network.virtual_hub_route_table_v2s

Fields

The following fields are returned by SELECT queries:

get

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.
attachedConnections	array	List of all connections attached to this route table v2.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the virtual hub route table v2 resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routes	array	List of all routes.

list

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.
attachedConnections	array	List of all connections attached to this route table v2.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the virtual hub route table v2 resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routes	array	List of all routes.

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

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 VirtualHubRouteTableV2. Required.
subscription_id	string
virtual_hub_name	string	The name of the Virtual Hub. Required.

SELECT examples

get

Retrieves the details of a VirtualHubRouteTableV2.

SELECT
id,
name,
attachedConnections,
etag,
provisioningState,
routes
FROM azure.network.virtual_hub_route_table_v2s
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 VirtualHubRouteTableV2s.

SELECT
id,
name,
attachedConnections,
etag,
provisioningState,
routes
FROM azure.network.virtual_hub_route_table_v2s
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 VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2.

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

Manifest

# Description fields are for documentation purposes
- name: virtual_hub_route_table_v2s
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_hub_route_table_v2s resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the virtual_hub_route_table_v2s resource.
  - name: route_table_name
    value: "{{ route_table_name }}"
    description: Required parameter for the virtual_hub_route_table_v2s resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_hub_route_table_v2s resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the virtual hub route table v2.
    value:
      routes:
        - destinationType: "{{ destinationType }}"
          destinations: "{{ destinations }}"
          nextHopType: "{{ nextHopType }}"
          nextHops: "{{ nextHops }}"
      attachedConnections:
        - "{{ attachedConnections }}"
      provisioningState: "{{ provisioningState }}"
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource that is unique within a resource group. This name can be used to access the resource.

REPLACE examples

create_or_update

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

REPLACE azure.network.virtual_hub_route_table_v2s
SET 
id = '{{ id }}',
properties = '{{ properties }}',
name = '{{ name }}'
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;

DELETE examples

delete

Deletes a VirtualHubRouteTableV2.

DELETE FROM azure.network.virtual_hub_route_table_v2s
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
;