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

RouteServer

class RouteServer : KotlinCustomResource

Manages an Azure Route Server

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 exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-vn",
    addressSpaces: ["10.0.0.0/16"],
    resourceGroupName: example.name,
    location: example.location,
    tags: {
        environment: "Production",
    },
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "RouteServerSubnet",
    virtualNetworkName: exampleVirtualNetwork.name,
    resourceGroupName: example.name,
    addressPrefixes: ["10.0.1.0/24"],
});
const examplePublicIp = new azure.network.PublicIp("example", {
    name: "example-pip",
    resourceGroupName: example.name,
    location: example.location,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleRouteServer = new azure.network.RouteServer("example", {
    name: "example-routerserver",
    resourceGroupName: example.name,
    location: example.location,
    sku: "Standard",
    publicIpAddressId: examplePublicIp.id,
    subnetId: exampleSubnet.id,
    branchToBranchTrafficEnabled: true,
    hubRoutingPreference: "ASPath",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-vn",
    address_spaces=["10.0.0.0/16"],
    resource_group_name=example.name,
    location=example.location,
    tags={
        "environment": "Production",
    })
example_subnet = azure.network.Subnet("example",
    name="RouteServerSubnet",
    virtual_network_name=example_virtual_network.name,
    resource_group_name=example.name,
    address_prefixes=["10.0.1.0/24"])
example_public_ip = azure.network.PublicIp("example",
    name="example-pip",
    resource_group_name=example.name,
    location=example.location,
    allocation_method="Static",
    sku="Standard")
example_route_server = azure.network.RouteServer("example",
    name="example-routerserver",
    resource_group_name=example.name,
    location=example.location,
    sku="Standard",
    public_ip_address_id=example_public_ip.id,
    subnet_id=example_subnet.id,
    branch_to_branch_traffic_enabled=True,
    hub_routing_preference="ASPath")
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 exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-vn",
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        ResourceGroupName = example.Name,
        Location = example.Location,
        Tags =
        {
            { "environment", "Production" },
        },
    });
    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "RouteServerSubnet",
        VirtualNetworkName = exampleVirtualNetwork.Name,
        ResourceGroupName = example.Name,
        AddressPrefixes = new[]
        {
            "10.0.1.0/24",
        },
    });
    var examplePublicIp = new Azure.Network.PublicIp("example", new()
    {
        Name = "example-pip",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AllocationMethod = "Static",
        Sku = "Standard",
    });
    var exampleRouteServer = new Azure.Network.RouteServer("example", new()
    {
        Name = "example-routerserver",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Sku = "Standard",
        PublicIpAddressId = examplePublicIp.Id,
        SubnetId = exampleSubnet.Id,
        BranchToBranchTrafficEnabled = true,
        HubRoutingPreference = "ASPath",
    });
});
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
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name: pulumi.String("example-vn"),
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("RouteServerSubnet"),
			VirtualNetworkName: exampleVirtualNetwork.Name,
			ResourceGroupName:  example.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.1.0/24"),
			},
		})
		if err != nil {
			return err
		}
		examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
			Name:              pulumi.String("example-pip"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			AllocationMethod:  pulumi.String("Static"),
			Sku:               pulumi.String("Standard"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewRouteServer(ctx, "example", &network.RouteServerArgs{
			Name:                         pulumi.String("example-routerserver"),
			ResourceGroupName:            example.Name,
			Location:                     example.Location,
			Sku:                          pulumi.String("Standard"),
			PublicIpAddressId:            examplePublicIp.ID(),
			SubnetId:                     exampleSubnet.ID(),
			BranchToBranchTrafficEnabled: pulumi.Bool(true),
			HubRoutingPreference:         pulumi.String("ASPath"),
		})
		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.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.network.RouteServer;
import com.pulumi.azure.network.RouteServerArgs;
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 exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-vn")
            .addressSpaces("10.0.0.0/16")
            .resourceGroupName(example.name())
            .location(example.location())
            .tags(Map.of("environment", "Production"))
            .build());
        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("RouteServerSubnet")
            .virtualNetworkName(exampleVirtualNetwork.name())
            .resourceGroupName(example.name())
            .addressPrefixes("10.0.1.0/24")
            .build());
        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
            .name("example-pip")
            .resourceGroupName(example.name())
            .location(example.location())
            .allocationMethod("Static")
            .sku("Standard")
            .build());
        var exampleRouteServer = new RouteServer("exampleRouteServer", RouteServerArgs.builder()
            .name("example-routerserver")
            .resourceGroupName(example.name())
            .location(example.location())
            .sku("Standard")
            .publicIpAddressId(examplePublicIp.id())
            .subnetId(exampleSubnet.id())
            .branchToBranchTrafficEnabled(true)
            .hubRoutingPreference("ASPath")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-vn
      addressSpaces:
        - 10.0.0.0/16
      resourceGroupName: ${example.name}
      location: ${example.location}
      tags:
        environment: Production
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: RouteServerSubnet
      virtualNetworkName: ${exampleVirtualNetwork.name}
      resourceGroupName: ${example.name}
      addressPrefixes:
        - 10.0.1.0/24
  examplePublicIp:
    type: azure:network:PublicIp
    name: example
    properties:
      name: example-pip
      resourceGroupName: ${example.name}
      location: ${example.location}
      allocationMethod: Static
      sku: Standard
  exampleRouteServer:
    type: azure:network:RouteServer
    name: example
    properties:
      name: example-routerserver
      resourceGroupName: ${example.name}
      location: ${example.location}
      sku: Standard
      publicIpAddressId: ${examplePublicIp.id}
      subnetId: ${exampleSubnet.id}
      branchToBranchTrafficEnabled: true
      hubRoutingPreference: ASPath
Content copied to clipboard

Import

Route Server can be imported using the resource id, e.g.

$ pulumi import azure:network/routeServer:RouteServer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/virtualHubs/routeServer1
Content copied to clipboard

Properties

Link copied to clipboard
val branchToBranchTrafficEnabled: Output<Boolean>?

Whether to enable route exchange between Azure Route Server and the gateway(s).

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

The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard
val publicIpAddressId: Output<String>

The ID of the Public IP Address. This option is required since September 1st 2021. Changing this forces a new resource to be created.

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

Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.

Link copied to clipboard
val routingState: Output<String>
Link copied to clipboard
val sku: Output<String>

The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.

Link copied to clipboard
val subnetId: Output<String>

The ID of the Subnet that the Route Server will reside. Changing this forces a new resource to be created.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags to assign to the resource.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val virtualRouterAsn: Output<Int>
Link copied to clipboard
val virtualRouterIps: Output<List<String>>