Microsoft.Network virtualHubs/hubRouteTables

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Microsoft.Network/virtualHubs/hubRouteTables@2023-04-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    labels: [
      'string'
    ]
    routes: [
      {
        destinations: [
          'string'
        ]
        destinationType: 'string'
        name: 'string'
        nextHop: 'string'
        nextHopType: 'string'
      }
    ]
  }
}

Property values

virtualHubs/hubRouteTables

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
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 RouteTable resource. HubRouteTableProperties

HubRouteTableProperties

Name Description Value
labels List of labels associated with this route table. string[]
routes List of all routes. HubRoute[]

HubRoute

Name Description Value
destinations List of all destinations. string[] (required)
destinationType The type of destinations (eg: CIDR, ResourceId, Service). string (required)
name The name of the Route that is unique within a RouteTable. This name can be used to access this route. string (required)
nextHop NextHop resource ID. string (required)
nextHopType The type of next hop (eg: ResourceId). string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Secured virtual hubs

Deploy to Azure
This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
Azure vWAN Multi-Hub Deployment with Custom Routing Tables

Deploy to Azure
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.

ARM template resource definition

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

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

Resource format

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

{
  "type": "Microsoft.Network/virtualHubs/hubRouteTables",
  "apiVersion": "2023-04-01",
  "name": "string",
  "properties": {
    "labels": [ "string" ],
    "routes": [
      {
        "destinations": [ "string" ],
        "destinationType": "string",
        "name": "string",
        "nextHop": "string",
        "nextHopType": "string"
      }
    ]
  }
}

Property values

virtualHubs/hubRouteTables

Name Description Value
type The resource type 'Microsoft.Network/virtualHubs/hubRouteTables'
apiVersion The resource api version '2023-04-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Properties of the RouteTable resource. HubRouteTableProperties

HubRouteTableProperties

Name Description Value
labels List of labels associated with this route table. string[]
routes List of all routes. HubRoute[]

HubRoute

Name Description Value
destinations List of all destinations. string[] (required)
destinationType The type of destinations (eg: CIDR, ResourceId, Service). string (required)
name The name of the Route that is unique within a RouteTable. This name can be used to access this route. string (required)
nextHop NextHop resource ID. string (required)
nextHopType The type of next hop (eg: ResourceId). string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Secured virtual hubs

Deploy to Azure
This template creates a secured virtual hub using Azure Firewall to secure your cloud network traffic destined to the Internet.
Azure vWAN Multi-Hub Deployment with Custom Routing Tables

Deploy to Azure
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.

Terraform (AzAPI provider) resource definition

The virtualHubs/hubRouteTables 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/hubRouteTables resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs/hubRouteTables@2023-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      labels = [
        "string"
      ]
      routes = [
        {
          destinations = [
            "string"
          ]
          destinationType = "string"
          name = "string"
          nextHop = "string"
          nextHopType = "string"
        }
      ]
    }
  })
}

Property values

virtualHubs/hubRouteTables

Name Description Value
type The resource type "Microsoft.Network/virtualHubs/hubRouteTables@2023-04-01"
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 RouteTable resource. HubRouteTableProperties

HubRouteTableProperties

Name Description Value
labels List of labels associated with this route table. string[]
routes List of all routes. HubRoute[]

HubRoute

Name Description Value
destinations List of all destinations. string[] (required)
destinationType The type of destinations (eg: CIDR, ResourceId, Service). string (required)
name The name of the Route that is unique within a RouteTable. This name can be used to access this route. string (required)
nextHop NextHop resource ID. string (required)
nextHopType The type of next hop (eg: ResourceId). string (required)