Route

class Route : KotlinCustomResource

Route resource. Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create route

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var route = new AzureNative.Network.Route("route", new()
{
AddressPrefix = "10.0.3.0/24",
NextHopType = AzureNative.Network.RouteNextHopType.VirtualNetworkGateway,
ResourceGroupName = "rg1",
RouteName = "route1",
RouteTableName = "testrt",
});
});
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewRoute(ctx, "route", &network.RouteArgs{
AddressPrefix: pulumi.String("10.0.3.0/24"),
NextHopType: pulumi.String(network.RouteNextHopTypeVirtualNetworkGateway),
ResourceGroupName: pulumi.String("rg1"),
RouteName: pulumi.String("route1"),
RouteTableName: pulumi.String("testrt"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.Route;
import com.pulumi.azurenative.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 route = new Route("route", RouteArgs.builder()
.addressPrefix("10.0.3.0/24")
.nextHopType("VirtualNetworkGateway")
.resourceGroupName("rg1")
.routeName("route1")
.routeTableName("testrt")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:Route route1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}

Properties

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

The destination CIDR to which the route applies.

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val etag: Output<String>

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard
val hasBgpOverride: Output<Boolean>

A value indicating whether this route overrides overlapping BGP routes regardless of LPM.

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

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Link copied to clipboard
val nextHopIpAddress: Output<String>?

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>

The type of Azure hop the packet should be sent to.

Link copied to clipboard

The provisioning state of the route resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val type: Output<String>?

The type of the resource.

Link copied to clipboard
val urn: Output<String>