virtual_hubs

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

Overview

Name	virtual_hubs
Type	Resource
Id	azure.network.virtual_hubs

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the VirtualHub retrieved.

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.
kind	string	Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
properties	object	Properties of the virtual hub.
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"

get_inbound_routes

Request successful. Returns the list of the effective route map routes or follow the location header for the inbound routes list.

Name	Datatype	Description
asPath	string	The ASPath of this route.
bgpCommunities	string	BGP communities of the route.
prefix	string	The address prefix of the route.

list_by_resource_group

Request successful. Returns the details of all the VirtualHubs in the resource group.

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.
kind	string	Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
properties	object	Properties of the virtual hub.
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. Returns the details of all the VirtualHubs in the subscription.

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.
kind	string	Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
properties	object	Properties of the virtual hub.
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	subscriptionId, resourceGroupName, virtualHubName		Retrieves the details of a VirtualHub.
get_inbound_routes	select	subscriptionId, resourceGroupName, virtualHubName		Gets the inbound routes configured for the Virtual Hub on a particular connection.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the VirtualHubs in a resource group.
list	select	subscriptionId		Lists all the VirtualHubs in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHubName, data__location		Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
delete	delete	subscriptionId, resourceGroupName, virtualHubName		Deletes a VirtualHub.
update_tags	exec	subscriptionId, resourceGroupName, virtualHubName		Updates VirtualHub 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 resource group name of the VirtualHub.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	string	The name of the VirtualHub.

SELECT examples

get

Retrieves the details of a VirtualHub.

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

get_inbound_routes

Gets the inbound routes configured for the Virtual Hub on a particular connection.

SELECT
asPath,
bgpCommunities,
prefix
FROM azure.network.virtual_hubs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- required
;

list_by_resource_group

Lists all the VirtualHubs in a resource group.

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

list

Lists all the VirtualHubs in a subscription.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: virtual_hubs
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_hubs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_hubs resource.
    - name: virtualHubName
      value: string
      description: Required parameter for the virtual_hubs resource.
    - name: properties
      value: object
      description: |
        Properties of the virtual hub.

DELETE examples

delete

Deletes a VirtualHub.

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

Lifecycle Methods

update_tags

Updates VirtualHub tags.

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