Skip to content

Commit

Permalink
Updating the Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tombuildsstuff committed Oct 6, 2017
1 parent 379be72 commit ffffb9a
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions website/docs/r/route.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ layout: "azurerm"
page_title: "Azure Resource Manager: azurerm_route-x"
sidebar_current: "docs-azurerm-resource-network-route"
description: |-
Creates and Managed a Route within a Route Table.
Manages a Route within a Route Table.
---

# azurerm_route

Creates and Managed a Route within a Route Table.
Manages a Route within a Route Table.

## Example Usage

Expand All @@ -20,39 +20,34 @@ resource "azurerm_resource_group" "test" {
resource "azurerm_route_table" "test" {
name = "acceptanceTestRouteTable1"
location = "West US"
location = "${azurerm_resource_group.test.location}"
resource_group_name = "${azurerm_resource_group.test.name}"
}
resource "azurerm_route" "test" {
name = "acceptanceTestRoute1"
resource_group_name = "${azurerm_resource_group.test.name}"
route_table_name = "${azurerm_route_table.test.name}"
address_prefix = "10.1.0.0/16"
next_hop_type = "vnetlocal"
address_prefix = "10.1.0.0/16"
next_hop_type = "vnetlocal"
}
```

## Argument Reference

The following arguments are supported:

* `name` - (Required) The name of the route. Changing this forces a
new resource to be created.

* `resource_group_name` - (Required) The name of the resource group in which to
create the route.
* `name` - (Required) The name of the route. Changing this forces a new resource to be created.

* `resource_group_name` - (Required) The name of the resource group in which to create the route. Changing this forces a new resource to be created.

* `route_table_name` - (Required) The name of the route table to which to create the route
* `route_table_name` - (Required) The name of the route table within which create the route. Changing this forces a new resource to be created.

* `address_prefix` - (Required) The destination CIDR to which the route applies, such as 10.1.0.0/16
* `address_prefix` - (Required) The destination CIDR to which the route applies, such as `10.1.0.0/16`

* `next_hop_type` - (Required) The type of Azure hop the packet should be sent to.
Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None
* `next_hop_type` - (Required) The type of Azure hop the packet should be sent to. Possible values are `VirtualNetworkGateway`, `VnetLocal`, `Internet`, `VirtualAppliance` and `None`

* `next_hop_in_ip_address` - (Optional) Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
* `next_hop_in_ip_address` - (Optional) Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is `VirtualAppliance`.

## Attributes Reference

Expand All @@ -62,8 +57,8 @@ The following attributes are exported:

## Import


Routes can be imported using the `resource id`, e.g.

```
terraform import azurerm_route.testRoute /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/routeTables/mytable1/routes/myroute1
```

0 comments on commit ffffb9a

Please sign in to comment.