virtual_hubs

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

Overview

Name	virtual_hubs
Type	Resource
Id	azure.network.virtual_hubs

Fields

vw_virtual_hubs

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
address_prefix	text	field from the properties object
allow_branch_to_branch_traffic	text	field from the properties object
azure_firewall	text	field from the properties object
bgp_connections	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
express_route_gateway	text	field from the properties object
hub_routing_preference	text	field from the properties object
ip_configurations	text	field from the properties object
kind	text	Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
location	text	Resource location.
p2_s_vpn_gateway	text	field from the properties object
preferred_routing_gateway	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
route_maps	text	field from the properties object
route_table	text	field from the properties object
routing_state	text	field from the properties object
security_partner_provider	text	field from the properties object
security_provider_name	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtualHubName	text	field from the properties object
virtual_hub_route_table_v2s	text	field from the properties object
virtual_router_asn	text	field from the properties object
virtual_router_auto_scale_configuration	text	field from the properties object
virtual_router_ips	text	field from the properties object
virtual_wan	text	field from the properties object
vpn_gateway	text	field from the properties object

virtual_hubs

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
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.
location	string	Resource location.
properties	object	Parameters for VirtualHub.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, virtualHubName	Retrieves the details of a VirtualHub.
get_inbound_routes	SELECT	resourceGroupName, subscriptionId, virtualHubName	Gets the inbound routes configured for the Virtual Hub on a particular connection.
list	SELECT	subscriptionId	Lists all the VirtualHubs in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all the VirtualHubs in a resource group.
create_or_update	INSERT	resourceGroupName, subscriptionId, virtualHubName, data__location	Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
delete	DELETE	resourceGroupName, subscriptionId, virtualHubName	Deletes a VirtualHub.
update_tags	EXEC	resourceGroupName, subscriptionId, virtualHubName	Updates VirtualHub tags.

SELECT examples

Lists all the VirtualHubs in a subscription.

vw_virtual_hubs

SELECT
id,
name,
address_prefix,
allow_branch_to_branch_traffic,
azure_firewall,
bgp_connections,
etag,
express_route_gateway,
hub_routing_preference,
ip_configurations,
kind,
location,
p2_s_vpn_gateway,
preferred_routing_gateway,
provisioning_state,
resourceGroupName,
route_maps,
route_table,
routing_state,
security_partner_provider,
security_provider_name,
sku,
subscriptionId,
tags,
type,
virtualHubName,
virtual_hub_route_table_v2s,
virtual_router_asn,
virtual_router_auto_scale_configuration,
virtual_router_ips,
virtual_wan,
vpn_gateway
FROM azure.network.vw_virtual_hubs
WHERE subscriptionId = '{{ subscriptionId }}';

virtual_hubs

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.virtual_hubs (
resourceGroupName,
subscriptionId,
virtualHubName,
data__location,
properties,
id,
location,
tags
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ virtualHubName }}',
'{{ data__location }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: virtualWan
          value:
            - name: id
              value: string
        - name: addressPrefix
          value: string
        - name: routeTable
          value:
            - name: routes
              value:
                - - name: addressPrefixes
                    value:
                      - string
                  - name: nextHopIpAddress
                    value: string
        - name: provisioningState
          value: []
        - name: securityProviderName
          value: string
        - name: virtualHubRouteTableV2s
          value:
            - - name: properties
                value:
                  - name: routes
                    value:
                      - - name: destinationType
                          value: string
                        - name: destinations
                          value:
                            - string
                        - name: nextHopType
                          value: string
                        - name: nextHops
                          value:
                            - string
                  - name: attachedConnections
                    value:
                      - string
              - name: name
                value: string
              - name: etag
                value: string
              - name: id
                value: string
        - name: sku
          value: string
        - name: routingState
          value: []
        - name: bgpConnections
          value:
            - - name: id
                value: string
        - name: ipConfigurations
          value:
            - - name: id
                value: string
        - name: routeMaps
          value:
            - - name: id
                value: string
        - name: virtualRouterAsn
          value: integer
        - name: virtualRouterIps
          value:
            - string
        - name: allowBranchToBranchTraffic
          value: boolean
        - name: preferredRoutingGateway
          value: []
        - name: hubRoutingPreference
          value: []
        - name: virtualRouterAutoScaleConfiguration
          value:
            - name: minCapacity
              value: integer
    - name: etag
      value: string
    - name: kind
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified virtual_hubs resource.

/*+ delete */
DELETE FROM azure.network.virtual_hubs
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualHubName = '{{ virtualHubName }}';