Microsoft.Network virtualHubs/hubVirtualNetworkConnections 2021-08-01

• Latest
• 2024-07-01
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01
• 2018-06-01
• 2018-04-01

Bicep resource definition

The virtualHubs/hubVirtualNetworkConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/virtualHubs/hubVirtualNetworkConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowHubToRemoteVnetTransit: bool
    allowRemoteVnetToUseHubVnetGateways: bool
    enableInternetSecurity: bool
    remoteVirtualNetwork: {
      id: 'string'
    }
    routingConfiguration: {
      associatedRouteTable: {
        id: 'string'
      }
      propagatedRouteTables: {
        ids: [
          {
            id: 'string'
          }
        ]
        labels: [
          'string'
        ]
      }
      vnetRoutes: {
        staticRoutes: [
          {
            addressPrefixes: [
              'string'
            ]
            name: 'string'
            nextHopIpAddress: 'string'
          }
        ]
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: virtualHubs
properties	Properties of the hub virtual network connection.	HubVirtualNetworkConnectionProperties

HubVirtualNetworkConnectionProperties

Name	Description	Value
allowHubToRemoteVnetTransit	Deprecated: VirtualHub to RemoteVnet transit to enabled or not.	bool
allowRemoteVnetToUseHubVnetGateways	Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.	bool
enableInternetSecurity	Enable internet security.	bool
remoteVirtualNetwork	Reference to the remote virtual network.	SubResource
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

SubResource

Name	Description	Value
id	Resource ID.	string

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.

ARM template resource definition

The virtualHubs/hubVirtualNetworkConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/virtualHubs/hubVirtualNetworkConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "allowHubToRemoteVnetTransit": "bool",
    "allowRemoteVnetToUseHubVnetGateways": "bool",
    "enableInternetSecurity": "bool",
    "remoteVirtualNetwork": {
      "id": "string"
    },
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "string"
      },
      "propagatedRouteTables": {
        "ids": [
          {
            "id": "string"
          }
        ],
        "labels": [ "string" ]
      },
      "vnetRoutes": {
        "staticRoutes": [
          {
            "addressPrefixes": [ "string" ],
            "name": "string",
            "nextHopIpAddress": "string"
          }
        ]
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

Name	Description	Value
apiVersion	The api version	'2021-08-01'
name	The resource name	string (required)
properties	Properties of the hub virtual network connection.	HubVirtualNetworkConnectionProperties
type	The resource type	'Microsoft.Network/virtualHubs/hubVirtualNetworkConnections'

HubVirtualNetworkConnectionProperties

Name	Description	Value
allowHubToRemoteVnetTransit	Deprecated: VirtualHub to RemoteVnet transit to enabled or not.	bool
allowRemoteVnetToUseHubVnetGateways	Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.	bool
enableInternetSecurity	Enable internet security.	bool
remoteVirtualNetwork	Reference to the remote virtual network.	SubResource
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

SubResource

Name	Description	Value
id	Resource ID.	string

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Virtual WAN (vWAN) Multi-Hub Deployment	This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment including all gateways and VNET connections.
Azure vWAN Multi-Hub Deployment with Custom Routing Tables	This template allows you to create an Azure Virtual WAN (vWAN) multi-hub deployment, including all gateways and VNET connections, and demonstrate the usage of Route Tables for custom routing.
Secured virtual hubs	This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
vWAN P2S deployment with multi address pool and user groups	This template deploys Azure Virtual WAN (vWAN) with a P2S configured with multiple address pool and user groups

Terraform (AzAPI provider) resource definition

The virtualHubs/hubVirtualNetworkConnections resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/virtualHubs/hubVirtualNetworkConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-08-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      allowHubToRemoteVnetTransit = bool
      allowRemoteVnetToUseHubVnetGateways = bool
      enableInternetSecurity = bool
      remoteVirtualNetwork = {
        id = "string"
      }
      routingConfiguration = {
        associatedRouteTable = {
          id = "string"
        }
        propagatedRouteTables = {
          ids = [
            {
              id = "string"
            }
          ]
          labels = [
            "string"
          ]
        }
        vnetRoutes = {
          staticRoutes = [
            {
              addressPrefixes = [
                "string"
              ]
              name = "string"
              nextHopIpAddress = "string"
            }
          ]
        }
      }
    }
  }
}

Property Values

Microsoft.Network/virtualHubs/hubVirtualNetworkConnections

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: virtualHubs
properties	Properties of the hub virtual network connection.	HubVirtualNetworkConnectionProperties
type	The resource type	"Microsoft.Network/virtualHubs/hubVirtualNetworkConnections@2021-08-01"

HubVirtualNetworkConnectionProperties

Name	Description	Value
allowHubToRemoteVnetTransit	Deprecated: VirtualHub to RemoteVnet transit to enabled or not.	bool
allowRemoteVnetToUseHubVnetGateways	Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.	bool
enableInternetSecurity	Enable internet security.	bool
remoteVirtualNetwork	Reference to the remote virtual network.	SubResource
routingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.	RoutingConfiguration

PropagatedRouteTable

Name	Description	Value
ids	The list of resource ids of all the RouteTables.	SubResource[]
labels	The list of labels.	string[]

RoutingConfiguration

Name	Description	Value
associatedRouteTable	The resource id RouteTable associated with this RoutingConfiguration.	SubResource
propagatedRouteTables	The list of RouteTables to advertise the routes to.	PropagatedRouteTable
vnetRoutes	List of routes that control routing from VirtualHub into a virtual network connection.	VnetRoute

StaticRoute

Name	Description	Value
addressPrefixes	List of all address prefixes.	string[]
name	The name of the StaticRoute that is unique within a VnetRoute.	string
nextHopIpAddress	The ip address of the next hop.	string

SubResource

Name	Description	Value
id	Resource ID.	string

VnetRoute

Name	Description	Value
staticRoutes	List of all Static Routes.	StaticRoute[]