RouteTable

Manages a Route Table

NOTE on Route Tables and Routes: There is both a standalone route resource, and allows for Routes to be defined in-line within the route_table resource. At this time you cannot use a Route Table with in-line Routes in conjunction with any Route resources. Doing so will cause a conflict of Route configurations and will overwrite Routes.

Create a RouteTable Resource

new RouteTable(name: string, args: RouteTableArgs, opts?: CustomResourceOptions);

def RouteTable(resource_name, opts=None, disable_bgp_route_propagation=None, location=None, name=None, resource_group_name=None, routes=None, tags=None, __props__=None);

func NewRouteTable(ctx *Context, name string, args RouteTableArgs, opts ...ResourceOption) (*RouteTable, error)

public RouteTable(string name, RouteTableArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args RouteTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RouteTableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RouteTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

RouteTable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RouteTable resource accepts the following input properties:

ResourceGroupName string: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
DisableBgpRoutePropagation bool: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the route.
Routes List<RouteTableRouteArgs>: A list of objects representing routes. Each object accepts the arguments documented below.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
DisableBgpRoutePropagation bool: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the route.
Routes []RouteTableRoute: A list of objects representing routes. Each object accepts the arguments documented below.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
disableBgpRoutePropagation boolean: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the route.
routes RouteTableRoute[]: A list of objects representing routes. Each object accepts the arguments documented below.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
disable_bgp_route_propagation bool: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the route.
routes List[RouteTableRoute]: A list of objects representing routes. Each object accepts the arguments documented below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the RouteTable resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Subnets List<string>: The collection of Subnets associated with this route table.

Id string: The provider-assigned unique ID for this managed resource.
Subnets []string: The collection of Subnets associated with this route table.

id string: The provider-assigned unique ID for this managed resource.
subnets string[]: The collection of Subnets associated with this route table.

id str: The provider-assigned unique ID for this managed resource.
subnets List[str]: The collection of Subnets associated with this route table.

Look up an Existing RouteTable Resource

Get an existing RouteTable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RouteTableState, opts?: CustomResourceOptions): RouteTable

static get(resource_name, id, opts=None, disable_bgp_route_propagation=None, location=None, name=None, resource_group_name=None, routes=None, subnets=None, tags=None, __props__=None);

func GetRouteTable(ctx *Context, name string, id IDInput, state *RouteTableState, opts ...ResourceOption) (*RouteTable, error)

public static RouteTable Get(string name, Input<string> id, RouteTableState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DisableBgpRoutePropagation bool: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the route.
ResourceGroupName string: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
Routes List<RouteTableRouteArgs>: A list of objects representing routes. Each object accepts the arguments documented below.
Subnets List<string>: The collection of Subnets associated with this route table.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

DisableBgpRoutePropagation bool: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the route.
ResourceGroupName string: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
Routes []RouteTableRoute: A list of objects representing routes. Each object accepts the arguments documented below.
Subnets []string: The collection of Subnets associated with this route table.
Tags map[string]string: A mapping of tags to assign to the resource.

disableBgpRoutePropagation boolean: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the route.
resourceGroupName string: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
routes RouteTableRoute[]: A list of objects representing routes. Each object accepts the arguments documented below.
subnets string[]: The collection of Subnets associated with this route table.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

disable_bgp_route_propagation bool: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the route.
resource_group_name str: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
routes List[RouteTableRoute]: A list of objects representing routes. Each object accepts the arguments documented below.
subnets List[str]: The collection of Subnets associated with this route table.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

RouteTableRoute

See the input and output API doc for this type.

AddressPrefix string: The destination CIDR to which the route applies, such as 10.1.0.0/16
Name string: The name of the route.
NextHopType string: The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None.
NextHopInIpAddress string: Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

AddressPrefix string: The destination CIDR to which the route applies, such as 10.1.0.0/16
Name string: The name of the route.
NextHopType string: The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None.
NextHopInIpAddress string: Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

addressPrefix string: The destination CIDR to which the route applies, such as 10.1.0.0/16
name string: The name of the route.
nextHopType string: The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None.
nextHopInIpAddress string: Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

address_prefix str: The destination CIDR to which the route applies, such as 10.1.0.0/16
name str: The name of the route.
next_hop_type str: 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 str: Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud