Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. RouteServer

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.RouteServer

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    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",
});

    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")

    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
	})
}

    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",
    });

});

    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());

    }
}

    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

    Create RouteServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RouteServer(name: string, args: RouteServerArgs, opts?: CustomResourceOptions);
    @overload
def RouteServer(resource_name: str,
                args: RouteServerArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def RouteServer(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                public_ip_address_id: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                sku: Optional[str] = None,
                subnet_id: Optional[str] = None,
                branch_to_branch_traffic_enabled: Optional[bool] = None,
                hub_routing_preference: Optional[str] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewRouteServer(ctx *Context, name string, args RouteServerArgs, opts ...ResourceOption) (*RouteServer, error)
    public RouteServer(string name, RouteServerArgs args, CustomResourceOptions? opts = null)
    public RouteServer(String name, RouteServerArgs args)
public RouteServer(String name, RouteServerArgs args, CustomResourceOptions options)

    type: azure:network:RouteServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RouteServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RouteServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RouteServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var routeServerResource = new Azure.Network.RouteServer("routeServerResource", new()
{
    PublicIpAddressId = "string",
    ResourceGroupName = "string",
    Sku = "string",
    SubnetId = "string",
    BranchToBranchTrafficEnabled = false,
    HubRoutingPreference = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := network.NewRouteServer(ctx, "routeServerResource", &network.RouteServerArgs{
	PublicIpAddressId:            pulumi.String("string"),
	ResourceGroupName:            pulumi.String("string"),
	Sku:                          pulumi.String("string"),
	SubnetId:                     pulumi.String("string"),
	BranchToBranchTrafficEnabled: pulumi.Bool(false),
	HubRoutingPreference:         pulumi.String("string"),
	Location:                     pulumi.String("string"),
	Name:                         pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var routeServerResource = new RouteServer("routeServerResource", RouteServerArgs.builder()
    .publicIpAddressId("string")
    .resourceGroupName("string")
    .sku("string")
    .subnetId("string")
    .branchToBranchTrafficEnabled(false)
    .hubRoutingPreference("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    route_server_resource = azure.network.RouteServer("routeServerResource",
    public_ip_address_id="string",
    resource_group_name="string",
    sku="string",
    subnet_id="string",
    branch_to_branch_traffic_enabled=False,
    hub_routing_preference="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const routeServerResource = new azure.network.RouteServer("routeServerResource", {
    publicIpAddressId: "string",
    resourceGroupName: "string",
    sku: "string",
    subnetId: "string",
    branchToBranchTrafficEnabled: false,
    hubRoutingPreference: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:network:RouteServer
properties:
    branchToBranchTrafficEnabled: false
    hubRoutingPreference: string
    location: string
    name: string
    publicIpAddressId: string
    resourceGroupName: string
    sku: string
    subnetId: string
    tags:
        string: string

    RouteServer Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RouteServer resource accepts the following input properties:

    PublicIpAddressId 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.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    SubnetId string

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    BranchToBranchTrafficEnabled bool
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    HubRoutingPreference string
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    Location string
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Route Server. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    PublicIpAddressId 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.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    Sku string
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    SubnetId string

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    BranchToBranchTrafficEnabled bool
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    HubRoutingPreference string
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    Location string
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Route Server. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    publicIpAddressId 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.
    resourceGroupName String
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    sku String
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnetId String

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    branchToBranchTrafficEnabled Boolean
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hubRoutingPreference String
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location String
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name String
    The name of the Route Server. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    publicIpAddressId 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.
    resourceGroupName string
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    sku string
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnetId string

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    branchToBranchTrafficEnabled boolean
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hubRoutingPreference string
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location string
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name string
    The name of the Route Server. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    public_ip_address_id str
    The ID of the Public IP Address. This option is required since September 1st 2021. Changing this forces a new resource to be created.
    resource_group_name str
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    sku str
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnet_id str

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    branch_to_branch_traffic_enabled bool
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hub_routing_preference str
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location str
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name str
    The name of the Route Server. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    publicIpAddressId 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.
    resourceGroupName String
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    sku String
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnetId String

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    branchToBranchTrafficEnabled Boolean
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hubRoutingPreference String
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location String
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name String
    The name of the Route Server. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RoutingState string
    VirtualRouterAsn int
    VirtualRouterIps List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    RoutingState string
    VirtualRouterAsn int
    VirtualRouterIps []string
    id String
    The provider-assigned unique ID for this managed resource.
    routingState String
    virtualRouterAsn Integer
    virtualRouterIps List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    routingState string
    virtualRouterAsn number
    virtualRouterIps string[]
    id str
    The provider-assigned unique ID for this managed resource.
    routing_state str
    virtual_router_asn int
    virtual_router_ips Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    routingState String
    virtualRouterAsn Number
    virtualRouterIps List<String>

    Look up Existing RouteServer Resource

    Get an existing RouteServer 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?: RouteServerState, opts?: CustomResourceOptions): RouteServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch_to_branch_traffic_enabled: Optional[bool] = None,
        hub_routing_preference: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        public_ip_address_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        routing_state: Optional[str] = None,
        sku: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_router_asn: Optional[int] = None,
        virtual_router_ips: Optional[Sequence[str]] = None) -> RouteServer
    func GetRouteServer(ctx *Context, name string, id IDInput, state *RouteServerState, opts ...ResourceOption) (*RouteServer, error)
    public static RouteServer Get(string name, Input<string> id, RouteServerState? state, CustomResourceOptions? opts = null)
    public static RouteServer get(String name, Output<String> id, RouteServerState state, CustomResourceOptions options)
    resources:  _:    type: azure:network:RouteServer    get:      id: ${id}
    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.
    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:
    BranchToBranchTrafficEnabled bool
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    HubRoutingPreference string
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    Location string
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Route Server. Changing this forces a new resource to be created.
    PublicIpAddressId 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.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    RoutingState string
    Sku string
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    SubnetId string

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VirtualRouterAsn int
    VirtualRouterIps List<string>
    BranchToBranchTrafficEnabled bool
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    HubRoutingPreference string
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    Location string
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Route Server. Changing this forces a new resource to be created.
    PublicIpAddressId 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.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    RoutingState string
    Sku string
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    SubnetId string

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    Tags map[string]string
    A mapping of tags to assign to the resource.
    VirtualRouterAsn int
    VirtualRouterIps []string
    branchToBranchTrafficEnabled Boolean
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hubRoutingPreference String
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location String
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name String
    The name of the Route Server. Changing this forces a new resource to be created.
    publicIpAddressId 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.
    resourceGroupName String
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    routingState String
    sku String
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnetId String

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    tags Map<String,String>
    A mapping of tags to assign to the resource.
    virtualRouterAsn Integer
    virtualRouterIps List<String>
    branchToBranchTrafficEnabled boolean
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hubRoutingPreference string
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location string
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name string
    The name of the Route Server. Changing this forces a new resource to be created.
    publicIpAddressId 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.
    resourceGroupName string
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    routingState string
    sku string
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnetId string

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    virtualRouterAsn number
    virtualRouterIps string[]
    branch_to_branch_traffic_enabled bool
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hub_routing_preference str
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location str
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name str
    The name of the Route Server. Changing this forces a new resource to be created.
    public_ip_address_id str
    The ID of the Public IP Address. This option is required since September 1st 2021. Changing this forces a new resource to be created.
    resource_group_name str
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    routing_state str
    sku str
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnet_id str

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    virtual_router_asn int
    virtual_router_ips Sequence[str]
    branchToBranchTrafficEnabled Boolean
    Whether to enable route exchange between Azure Route Server and the gateway(s).
    hubRoutingPreference String
    The hub routing preference. Valid values are ASPath, ExpressRoute or VpnGateway. Defaults to ExpressRoute.
    location String
    Specifies the supported Azure location where the Route Server should exist. Changing this forces a new resource to be created.
    name String
    The name of the Route Server. Changing this forces a new resource to be created.
    publicIpAddressId 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.
    resourceGroupName String
    Specifies the name of the Resource Group where the Route Server should exist. Changing this forces a new resource to be created.
    routingState String
    sku String
    The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created.
    subnetId String

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

    NOTE: Azure Route Server requires a dedicated subnet named RouteServerSubnet. The subnet size has to be at least /27 or short prefix (such as /26 or /25) and cannot be attached to any security group, otherwise, you'll receive an error message when deploying the Route Server.

    tags Map<String>
    A mapping of tags to assign to the resource.
    virtualRouterAsn Number
    virtualRouterIps List<String>

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure