Share via

Microsoft.Network routeTables/routes 2023-09-01

  • Article

Bicep resource definition

The routeTables/routes 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/routeTables/routes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/routeTables/routes@2023-09-01' = {
  name: 'string'
  properties: {
    addressPrefix: 'string'
    nextHopIpAddress: 'string'
    nextHopType: 'string'
  }
}

Property values

Microsoft.Network/routeTables/routes

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: routeTables
properties Properties of the route. RoutePropertiesFormat

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
nextHopType The type of Azure hop the packet should be sent to. 'Internet'
'None'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal' (required)

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Create sandbox of Azure Firewall, client VM, and server VM This template creates a virtual network with 2 subnets (server subnet and AzureFirewall subnet), A server VM, a client VM, a public IP address for each VM, and a route table to send traffic between VMs through the firewall.

ARM template resource definition

The routeTables/routes 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/routeTables/routes resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/routeTables/routes",
  "apiVersion": "2023-09-01",
  "name": "string",
  "properties": {
    "addressPrefix": "string",
    "nextHopIpAddress": "string",
    "nextHopType": "string"
  }
}

Property values

Microsoft.Network/routeTables/routes

Name Description Value
apiVersion The api version '2023-09-01'
name The resource name string (required)
properties Properties of the route. RoutePropertiesFormat
type The resource type 'Microsoft.Network/routeTables/routes'

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
nextHopType The type of Azure hop the packet should be sent to. 'Internet'
'None'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create sandbox of Azure Firewall, client VM, and server VM

Deploy to Azure		 This template creates a virtual network with 2 subnets (server subnet and AzureFirewall subnet), A server VM, a client VM, a public IP address for each VM, and a route table to send traffic between VMs through the firewall.
VNS3 network appliance for cloud connectivity and security

Deploy to Azure		 VNS3 is a software only virtual appliance that provides the combined features and functions of a security appliance, application delivery controller and unified threat management device at the cloud application edge. Key benefits, on top of cloud networking, always on end to end encryption, federate data centres, cloud regions, cloud providers, and/or containers, creating one unified address space, attestable control over encryption keys, meshed network manageable at scale, reliable HA in the cloud, isolate sensitive applications (fast low cost Network Segmentation), segmentation within applications, Analysis of all data in motion in the cloud. Key network functions; virtual router, switch, firewall, vpn concentrator, multicast distributor, with plugins for WAF, NIDS, caching, proxy, load balancers and other layer 4 thru 7 network functions, VNS3 doesn't require new knowledge or training to implement, so you can integrate with existing network equipment.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/routeTables/routes@2023-09-01"
  name = "string"
  body = jsonencode({
    properties = {
      addressPrefix = "string"
      nextHopIpAddress = "string"
      nextHopType = "string"
    }
  })
}

Property values

Microsoft.Network/routeTables/routes

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: routeTables
properties Properties of the route. RoutePropertiesFormat
type The resource type "Microsoft.Network/routeTables/routes@2023-09-01"

RoutePropertiesFormat

Name Description Value
addressPrefix The destination CIDR to which the route applies. string
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
nextHopType The type of Azure hop the packet should be sent to. 'Internet'
'None'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal' (required)