This type represents a Microsoft™ Azure route.

In the blueprint designer, you can configure the properties that the following table includes. Properties are listed as either core or extended. Each type of property is located in separate sections of the heat resource that you can view in the blueprint designer. You set the core properties in the properties section and set the extended properties in the metadata section of the blueprint.

Table 1. Properties
Name Type Required Core or extended Description
address_prefix String True Core The destination CIDR to which the route applies.
name String True Core The name of the route table. If the specified name exists, a new unique name is created.
next_hop_type String True Core The type of Azure hop that the packet should be sent to. Valid values are as follows:
  • VirtualNetworkGateway
  • VnetLocal
  • Internet
  • VirtualAppliance
  • None
next_hop_ip_address String False Core The IP address that packets should be forwarded to if the hop type is VirtualAppliance.
resource_group String True Core The name of the resource group.
route_table_name String True Core The Azure location. The blueprint designer specifies this property automatically, based on the selected region.
Table 2. Attributes
Attribute Type Description
name String The name of the route.
route_id String The Azure ID of the route ID.
show String The details of the route.


This example creates a route table.
    type: IBM::Azure::RouteTable
      name: test-route-table
          tag1 : value1
          tag2 : value2
This example creates a route for the new route table.
    type: IBM::Azure::Route
      name: test-route-1
      resource_group: test-resource-group
      route_table_name: {get_attr: [azure_route_table_1, name]}
      next_hop_type: Internet