pulumi-azure-kotlin/com.pulumi.azure.network.kotlin/RouteArgs

RouteArgs

data class RouteArgs(val addressPrefix: Output<String>? = null, val name: Output<String>? = null, val nextHopInIpAddress: Output<String>? = null, val nextHopType: Output<String>? = null, val resourceGroupName: Output<String>? = null, val routeTableName: Output<String>? = null) : ConvertibleToJava<RouteArgs>

Manages a Route within a Route Table.

NOTE on Route Tables and Routes: This provider currently provides 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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleRouteTable = new azure.network.RouteTable("example", {
    name: "acceptanceTestRouteTable1",
    location: example.location,
    resourceGroupName: example.name,
});
const exampleRoute = new azure.network.Route("example", {
    name: "acceptanceTestRoute1",
    resourceGroupName: example.name,
    routeTableName: exampleRouteTable.name,
    addressPrefix: "10.1.0.0/16",
    nextHopType: "VnetLocal",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_route_table = azure.network.RouteTable("example",
    name="acceptanceTestRouteTable1",
    location=example.location,
    resource_group_name=example.name)
example_route = azure.network.Route("example",
    name="acceptanceTestRoute1",
    resource_group_name=example.name,
    route_table_name=example_route_table.name,
    address_prefix="10.1.0.0/16",
    next_hop_type="VnetLocal")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var exampleRouteTable = new Azure.Network.RouteTable("example", new()
    {
        Name = "acceptanceTestRouteTable1",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });
    var exampleRoute = new Azure.Network.Route("example", new()
    {
        Name = "acceptanceTestRoute1",
        ResourceGroupName = example.Name,
        RouteTableName = exampleRouteTable.Name,
        AddressPrefix = "10.1.0.0/16",
        NextHopType = "VnetLocal",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleRouteTable, err := network.NewRouteTable(ctx, "example", &network.RouteTableArgs{
			Name:              pulumi.String("acceptanceTestRouteTable1"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = network.NewRoute(ctx, "example", &network.RouteArgs{
			Name:              pulumi.String("acceptanceTestRoute1"),
			ResourceGroupName: example.Name,
			RouteTableName:    exampleRouteTable.Name,
			AddressPrefix:     pulumi.String("10.1.0.0/16"),
			NextHopType:       pulumi.String("VnetLocal"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.RouteTable;
import com.pulumi.azure.network.RouteTableArgs;
import com.pulumi.azure.network.Route;
import com.pulumi.azure.network.RouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleRouteTable = new RouteTable("exampleRouteTable", RouteTableArgs.builder()
            .name("acceptanceTestRouteTable1")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());
        var exampleRoute = new Route("exampleRoute", RouteArgs.builder()
            .name("acceptanceTestRoute1")
            .resourceGroupName(example.name())
            .routeTableName(exampleRouteTable.name())
            .addressPrefix("10.1.0.0/16")
            .nextHopType("VnetLocal")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleRouteTable:
    type: azure:network:RouteTable
    name: example
    properties:
      name: acceptanceTestRouteTable1
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleRoute:
    type: azure:network:Route
    name: example
    properties:
      name: acceptanceTestRoute1
      resourceGroupName: ${example.name}
      routeTableName: ${exampleRouteTable.name}
      addressPrefix: 10.1.0.0/16
      nextHopType: VnetLocal
Content copied to clipboard

Import

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

$ pulumi import azure:network/route:Route exampleRoute /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/routeTables/mytable1/routes/myroute1
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(addressPrefix: Output<String>? = null, name: Output<String>? = null, nextHopInIpAddress: Output<String>? = null, nextHopType: Output<String>? = null, resourceGroupName: Output<String>? = null, routeTableName: Output<String>? = null)

Properties

Link copied to clipboard
val addressPrefix: Output<String>? = null

The destination to which the route applies. Can be CIDR (such as 10.1.0.0/16) or Azure Service Tag (such as ApiManagement, AzureBackup or AzureMonitor) format.

Link copied to clipboard
val name: Output<String>? = null

The name of the route. Changing this forces a new resource to be created.

Link copied to clipboard
val nextHopInIpAddress: Output<String>? = null

Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

Link copied to clipboard
val nextHopType: Output<String>? = null

The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group in which to create the route. Changing this forces a new resource to be created.

Link copied to clipboard
val routeTableName: Output<String>? = null

The name of the route table within which create the route. Changing this forces a new resource to be created.

Functions

Link copied to clipboard
open override fun toJava(): RouteArgs