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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.ExpressRouteConnection

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Express Route Connection.

NOTE: The provider status of the Express Route Circuit must be set as provisioned while creating the Express Route Connection. See more details here.

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 exampleVirtualWan = new azure.network.VirtualWan("example", {
    name: "example-vwan",
    resourceGroupName: example.name,
    location: example.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("example", {
    name: "example-vhub",
    resourceGroupName: example.name,
    location: example.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});
const exampleExpressRouteGateway = new azure.network.ExpressRouteGateway("example", {
    name: "example-expressroutegateway",
    resourceGroupName: example.name,
    location: example.location,
    virtualHubId: exampleVirtualHub.id,
    scaleUnits: 1,
});
const exampleExpressRoutePort = new azure.network.ExpressRoutePort("example", {
    name: "example-erp",
    resourceGroupName: example.name,
    location: example.location,
    peeringLocation: "Equinix-Seattle-SE2",
    bandwidthInGbps: 10,
    encapsulation: "Dot1Q",
});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("example", {
    name: "example-erc",
    location: example.location,
    resourceGroupName: example.name,
    expressRoutePortId: exampleExpressRoutePort.id,
    bandwidthInGbps: 5,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
});
const exampleExpressRouteCircuitPeering = new azure.network.ExpressRouteCircuitPeering("example", {
    peeringType: "AzurePrivatePeering",
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: example.name,
    sharedKey: "ItsASecret",
    peerAsn: 100,
    primaryPeerAddressPrefix: "192.168.1.0/30",
    secondaryPeerAddressPrefix: "192.168.2.0/30",
    vlanId: 100,
});
const exampleExpressRouteConnection = new azure.network.ExpressRouteConnection("example", {
    name: "example-expressrouteconn",
    expressRouteGatewayId: exampleExpressRouteGateway.id,
    expressRouteCircuitPeeringId: exampleExpressRouteCircuitPeering.id,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_wan = azure.network.VirtualWan("example",
    name="example-vwan",
    resource_group_name=example.name,
    location=example.location)
example_virtual_hub = azure.network.VirtualHub("example",
    name="example-vhub",
    resource_group_name=example.name,
    location=example.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")
example_express_route_gateway = azure.network.ExpressRouteGateway("example",
    name="example-expressroutegateway",
    resource_group_name=example.name,
    location=example.location,
    virtual_hub_id=example_virtual_hub.id,
    scale_units=1)
example_express_route_port = azure.network.ExpressRoutePort("example",
    name="example-erp",
    resource_group_name=example.name,
    location=example.location,
    peering_location="Equinix-Seattle-SE2",
    bandwidth_in_gbps=10,
    encapsulation="Dot1Q")
example_express_route_circuit = azure.network.ExpressRouteCircuit("example",
    name="example-erc",
    location=example.location,
    resource_group_name=example.name,
    express_route_port_id=example_express_route_port.id,
    bandwidth_in_gbps=5,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    })
example_express_route_circuit_peering = azure.network.ExpressRouteCircuitPeering("example",
    peering_type="AzurePrivatePeering",
    express_route_circuit_name=example_express_route_circuit.name,
    resource_group_name=example.name,
    shared_key="ItsASecret",
    peer_asn=100,
    primary_peer_address_prefix="192.168.1.0/30",
    secondary_peer_address_prefix="192.168.2.0/30",
    vlan_id=100)
example_express_route_connection = azure.network.ExpressRouteConnection("example",
    name="example-expressrouteconn",
    express_route_gateway_id=example_express_route_gateway.id,
    express_route_circuit_peering_id=example_express_route_circuit_peering.id)
Copy
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
		}
		exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
			Name:              pulumi.String("example-vwan"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		exampleVirtualHub, err := network.NewVirtualHub(ctx, "example", &network.VirtualHubArgs{
			Name:              pulumi.String("example-vhub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VirtualWanId:      exampleVirtualWan.ID(),
			AddressPrefix:     pulumi.String("10.0.1.0/24"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteGateway, err := network.NewExpressRouteGateway(ctx, "example", &network.ExpressRouteGatewayArgs{
			Name:              pulumi.String("example-expressroutegateway"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VirtualHubId:      exampleVirtualHub.ID(),
			ScaleUnits:        pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		exampleExpressRoutePort, err := network.NewExpressRoutePort(ctx, "example", &network.ExpressRoutePortArgs{
			Name:              pulumi.String("example-erp"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			PeeringLocation:   pulumi.String("Equinix-Seattle-SE2"),
			BandwidthInGbps:   pulumi.Int(10),
			Encapsulation:     pulumi.String("Dot1Q"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuit, err := network.NewExpressRouteCircuit(ctx, "example", &network.ExpressRouteCircuitArgs{
			Name:               pulumi.String("example-erc"),
			Location:           example.Location,
			ResourceGroupName:  example.Name,
			ExpressRoutePortId: exampleExpressRoutePort.ID(),
			BandwidthInGbps:    pulumi.Float64(5),
			Sku: &network.ExpressRouteCircuitSkuArgs{
				Tier:   pulumi.String("Standard"),
				Family: pulumi.String("MeteredData"),
			},
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuitPeering, err := network.NewExpressRouteCircuitPeering(ctx, "example", &network.ExpressRouteCircuitPeeringArgs{
			PeeringType:                pulumi.String("AzurePrivatePeering"),
			ExpressRouteCircuitName:    exampleExpressRouteCircuit.Name,
			ResourceGroupName:          example.Name,
			SharedKey:                  pulumi.String("ItsASecret"),
			PeerAsn:                    pulumi.Int(100),
			PrimaryPeerAddressPrefix:   pulumi.String("192.168.1.0/30"),
			SecondaryPeerAddressPrefix: pulumi.String("192.168.2.0/30"),
			VlanId:                     pulumi.Int(100),
		})
		if err != nil {
			return err
		}
		_, err = network.NewExpressRouteConnection(ctx, "example", &network.ExpressRouteConnectionArgs{
			Name:                         pulumi.String("example-expressrouteconn"),
			ExpressRouteGatewayId:        exampleExpressRouteGateway.ID(),
			ExpressRouteCircuitPeeringId: exampleExpressRouteCircuitPeering.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
    {
        Name = "example-vwan",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var exampleVirtualHub = new Azure.Network.VirtualHub("example", new()
    {
        Name = "example-vhub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VirtualWanId = exampleVirtualWan.Id,
        AddressPrefix = "10.0.1.0/24",
    });

    var exampleExpressRouteGateway = new Azure.Network.ExpressRouteGateway("example", new()
    {
        Name = "example-expressroutegateway",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VirtualHubId = exampleVirtualHub.Id,
        ScaleUnits = 1,
    });

    var exampleExpressRoutePort = new Azure.Network.ExpressRoutePort("example", new()
    {
        Name = "example-erp",
        ResourceGroupName = example.Name,
        Location = example.Location,
        PeeringLocation = "Equinix-Seattle-SE2",
        BandwidthInGbps = 10,
        Encapsulation = "Dot1Q",
    });

    var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("example", new()
    {
        Name = "example-erc",
        Location = example.Location,
        ResourceGroupName = example.Name,
        ExpressRoutePortId = exampleExpressRoutePort.Id,
        BandwidthInGbps = 5,
        Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
        {
            Tier = "Standard",
            Family = "MeteredData",
        },
    });

    var exampleExpressRouteCircuitPeering = new Azure.Network.ExpressRouteCircuitPeering("example", new()
    {
        PeeringType = "AzurePrivatePeering",
        ExpressRouteCircuitName = exampleExpressRouteCircuit.Name,
        ResourceGroupName = example.Name,
        SharedKey = "ItsASecret",
        PeerAsn = 100,
        PrimaryPeerAddressPrefix = "192.168.1.0/30",
        SecondaryPeerAddressPrefix = "192.168.2.0/30",
        VlanId = 100,
    });

    var exampleExpressRouteConnection = new Azure.Network.ExpressRouteConnection("example", new()
    {
        Name = "example-expressrouteconn",
        ExpressRouteGatewayId = exampleExpressRouteGateway.Id,
        ExpressRouteCircuitPeeringId = exampleExpressRouteCircuitPeering.Id,
    });

});
Copy
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.VirtualWan;
import com.pulumi.azure.network.VirtualWanArgs;
import com.pulumi.azure.network.VirtualHub;
import com.pulumi.azure.network.VirtualHubArgs;
import com.pulumi.azure.network.ExpressRouteGateway;
import com.pulumi.azure.network.ExpressRouteGatewayArgs;
import com.pulumi.azure.network.ExpressRoutePort;
import com.pulumi.azure.network.ExpressRoutePortArgs;
import com.pulumi.azure.network.ExpressRouteCircuit;
import com.pulumi.azure.network.ExpressRouteCircuitArgs;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitSkuArgs;
import com.pulumi.azure.network.ExpressRouteCircuitPeering;
import com.pulumi.azure.network.ExpressRouteCircuitPeeringArgs;
import com.pulumi.azure.network.ExpressRouteConnection;
import com.pulumi.azure.network.ExpressRouteConnectionArgs;
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 exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()
            .name("example-vwan")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var exampleVirtualHub = new VirtualHub("exampleVirtualHub", VirtualHubArgs.builder()
            .name("example-vhub")
            .resourceGroupName(example.name())
            .location(example.location())
            .virtualWanId(exampleVirtualWan.id())
            .addressPrefix("10.0.1.0/24")
            .build());

        var exampleExpressRouteGateway = new ExpressRouteGateway("exampleExpressRouteGateway", ExpressRouteGatewayArgs.builder()
            .name("example-expressroutegateway")
            .resourceGroupName(example.name())
            .location(example.location())
            .virtualHubId(exampleVirtualHub.id())
            .scaleUnits(1)
            .build());

        var exampleExpressRoutePort = new ExpressRoutePort("exampleExpressRoutePort", ExpressRoutePortArgs.builder()
            .name("example-erp")
            .resourceGroupName(example.name())
            .location(example.location())
            .peeringLocation("Equinix-Seattle-SE2")
            .bandwidthInGbps(10)
            .encapsulation("Dot1Q")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()
            .name("example-erc")
            .location(example.location())
            .resourceGroupName(example.name())
            .expressRoutePortId(exampleExpressRoutePort.id())
            .bandwidthInGbps(5)
            .sku(ExpressRouteCircuitSkuArgs.builder()
                .tier("Standard")
                .family("MeteredData")
                .build())
            .build());

        var exampleExpressRouteCircuitPeering = new ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", ExpressRouteCircuitPeeringArgs.builder()
            .peeringType("AzurePrivatePeering")
            .expressRouteCircuitName(exampleExpressRouteCircuit.name())
            .resourceGroupName(example.name())
            .sharedKey("ItsASecret")
            .peerAsn(100)
            .primaryPeerAddressPrefix("192.168.1.0/30")
            .secondaryPeerAddressPrefix("192.168.2.0/30")
            .vlanId(100)
            .build());

        var exampleExpressRouteConnection = new ExpressRouteConnection("exampleExpressRouteConnection", ExpressRouteConnectionArgs.builder()
            .name("example-expressrouteconn")
            .expressRouteGatewayId(exampleExpressRouteGateway.id())
            .expressRouteCircuitPeeringId(exampleExpressRouteCircuitPeering.id())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualWan:
    type: azure:network:VirtualWan
    name: example
    properties:
      name: example-vwan
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleVirtualHub:
    type: azure:network:VirtualHub
    name: example
    properties:
      name: example-vhub
      resourceGroupName: ${example.name}
      location: ${example.location}
      virtualWanId: ${exampleVirtualWan.id}
      addressPrefix: 10.0.1.0/24
  exampleExpressRouteGateway:
    type: azure:network:ExpressRouteGateway
    name: example
    properties:
      name: example-expressroutegateway
      resourceGroupName: ${example.name}
      location: ${example.location}
      virtualHubId: ${exampleVirtualHub.id}
      scaleUnits: 1
  exampleExpressRoutePort:
    type: azure:network:ExpressRoutePort
    name: example
    properties:
      name: example-erp
      resourceGroupName: ${example.name}
      location: ${example.location}
      peeringLocation: Equinix-Seattle-SE2
      bandwidthInGbps: 10
      encapsulation: Dot1Q
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    name: example
    properties:
      name: example-erc
      location: ${example.location}
      resourceGroupName: ${example.name}
      expressRoutePortId: ${exampleExpressRoutePort.id}
      bandwidthInGbps: 5
      sku:
        tier: Standard
        family: MeteredData
  exampleExpressRouteCircuitPeering:
    type: azure:network:ExpressRouteCircuitPeering
    name: example
    properties:
      peeringType: AzurePrivatePeering
      expressRouteCircuitName: ${exampleExpressRouteCircuit.name}
      resourceGroupName: ${example.name}
      sharedKey: ItsASecret
      peerAsn: 100
      primaryPeerAddressPrefix: 192.168.1.0/30
      secondaryPeerAddressPrefix: 192.168.2.0/30
      vlanId: 100
  exampleExpressRouteConnection:
    type: azure:network:ExpressRouteConnection
    name: example
    properties:
      name: example-expressrouteconn
      expressRouteGatewayId: ${exampleExpressRouteGateway.id}
      expressRouteCircuitPeeringId: ${exampleExpressRouteCircuitPeering.id}
Copy

Create ExpressRouteConnection Resource

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

Constructor syntax

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

@overload
def ExpressRouteConnection(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           express_route_circuit_peering_id: Optional[str] = None,
                           express_route_gateway_id: Optional[str] = None,
                           authorization_key: Optional[str] = None,
                           enable_internet_security: Optional[bool] = None,
                           express_route_gateway_bypass_enabled: Optional[bool] = None,
                           name: Optional[str] = None,
                           private_link_fast_path_enabled: Optional[bool] = None,
                           routing: Optional[ExpressRouteConnectionRoutingArgs] = None,
                           routing_weight: Optional[int] = None)
func NewExpressRouteConnection(ctx *Context, name string, args ExpressRouteConnectionArgs, opts ...ResourceOption) (*ExpressRouteConnection, error)
public ExpressRouteConnection(string name, ExpressRouteConnectionArgs args, CustomResourceOptions? opts = null)
public ExpressRouteConnection(String name, ExpressRouteConnectionArgs args)
public ExpressRouteConnection(String name, ExpressRouteConnectionArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ExpressRouteConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ExpressRouteConnectionArgs
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 expressRouteConnectionResource = new Azure.Network.ExpressRouteConnection("expressRouteConnectionResource", new()
{
    ExpressRouteCircuitPeeringId = "string",
    ExpressRouteGatewayId = "string",
    AuthorizationKey = "string",
    EnableInternetSecurity = false,
    ExpressRouteGatewayBypassEnabled = false,
    Name = "string",
    Routing = new Azure.Network.Inputs.ExpressRouteConnectionRoutingArgs
    {
        AssociatedRouteTableId = "string",
        InboundRouteMapId = "string",
        OutboundRouteMapId = "string",
        PropagatedRouteTable = new Azure.Network.Inputs.ExpressRouteConnectionRoutingPropagatedRouteTableArgs
        {
            Labels = new[]
            {
                "string",
            },
            RouteTableIds = new[]
            {
                "string",
            },
        },
    },
    RoutingWeight = 0,
});
Copy
example, err := network.NewExpressRouteConnection(ctx, "expressRouteConnectionResource", &network.ExpressRouteConnectionArgs{
	ExpressRouteCircuitPeeringId:     pulumi.String("string"),
	ExpressRouteGatewayId:            pulumi.String("string"),
	AuthorizationKey:                 pulumi.String("string"),
	EnableInternetSecurity:           pulumi.Bool(false),
	ExpressRouteGatewayBypassEnabled: pulumi.Bool(false),
	Name:                             pulumi.String("string"),
	Routing: &network.ExpressRouteConnectionRoutingArgs{
		AssociatedRouteTableId: pulumi.String("string"),
		InboundRouteMapId:      pulumi.String("string"),
		OutboundRouteMapId:     pulumi.String("string"),
		PropagatedRouteTable: &network.ExpressRouteConnectionRoutingPropagatedRouteTableArgs{
			Labels: pulumi.StringArray{
				pulumi.String("string"),
			},
			RouteTableIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	RoutingWeight: pulumi.Int(0),
})
Copy
var expressRouteConnectionResource = new ExpressRouteConnection("expressRouteConnectionResource", ExpressRouteConnectionArgs.builder()
    .expressRouteCircuitPeeringId("string")
    .expressRouteGatewayId("string")
    .authorizationKey("string")
    .enableInternetSecurity(false)
    .expressRouteGatewayBypassEnabled(false)
    .name("string")
    .routing(ExpressRouteConnectionRoutingArgs.builder()
        .associatedRouteTableId("string")
        .inboundRouteMapId("string")
        .outboundRouteMapId("string")
        .propagatedRouteTable(ExpressRouteConnectionRoutingPropagatedRouteTableArgs.builder()
            .labels("string")
            .routeTableIds("string")
            .build())
        .build())
    .routingWeight(0)
    .build());
Copy
express_route_connection_resource = azure.network.ExpressRouteConnection("expressRouteConnectionResource",
    express_route_circuit_peering_id="string",
    express_route_gateway_id="string",
    authorization_key="string",
    enable_internet_security=False,
    express_route_gateway_bypass_enabled=False,
    name="string",
    routing={
        "associated_route_table_id": "string",
        "inbound_route_map_id": "string",
        "outbound_route_map_id": "string",
        "propagated_route_table": {
            "labels": ["string"],
            "route_table_ids": ["string"],
        },
    },
    routing_weight=0)
Copy
const expressRouteConnectionResource = new azure.network.ExpressRouteConnection("expressRouteConnectionResource", {
    expressRouteCircuitPeeringId: "string",
    expressRouteGatewayId: "string",
    authorizationKey: "string",
    enableInternetSecurity: false,
    expressRouteGatewayBypassEnabled: false,
    name: "string",
    routing: {
        associatedRouteTableId: "string",
        inboundRouteMapId: "string",
        outboundRouteMapId: "string",
        propagatedRouteTable: {
            labels: ["string"],
            routeTableIds: ["string"],
        },
    },
    routingWeight: 0,
});
Copy
type: azure:network:ExpressRouteConnection
properties:
    authorizationKey: string
    enableInternetSecurity: false
    expressRouteCircuitPeeringId: string
    expressRouteGatewayBypassEnabled: false
    expressRouteGatewayId: string
    name: string
    routing:
        associatedRouteTableId: string
        inboundRouteMapId: string
        outboundRouteMapId: string
        propagatedRouteTable:
            labels:
                - string
            routeTableIds:
                - string
    routingWeight: 0
Copy

ExpressRouteConnection 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 ExpressRouteConnection resource accepts the following input properties:

ExpressRouteCircuitPeeringId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
ExpressRouteGatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
AuthorizationKey string
The authorization key to establish the Express Route Connection.
EnableInternetSecurity bool
Is Internet security enabled for this Express Route Connection?
ExpressRouteGatewayBypassEnabled bool
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
Name Changes to this property will trigger replacement. string
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
PrivateLinkFastPathEnabled bool

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

Routing ExpressRouteConnectionRouting
A routing block as defined below.
RoutingWeight int
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
ExpressRouteCircuitPeeringId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
ExpressRouteGatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
AuthorizationKey string
The authorization key to establish the Express Route Connection.
EnableInternetSecurity bool
Is Internet security enabled for this Express Route Connection?
ExpressRouteGatewayBypassEnabled bool
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
Name Changes to this property will trigger replacement. string
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
PrivateLinkFastPathEnabled bool

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

Routing ExpressRouteConnectionRoutingArgs
A routing block as defined below.
RoutingWeight int
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
expressRouteCircuitPeeringId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
expressRouteGatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
authorizationKey String
The authorization key to establish the Express Route Connection.
enableInternetSecurity Boolean
Is Internet security enabled for this Express Route Connection?
expressRouteGatewayBypassEnabled Boolean
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
name Changes to this property will trigger replacement. String
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
privateLinkFastPathEnabled Boolean

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing ExpressRouteConnectionRouting
A routing block as defined below.
routingWeight Integer
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
expressRouteCircuitPeeringId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
expressRouteGatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
authorizationKey string
The authorization key to establish the Express Route Connection.
enableInternetSecurity boolean
Is Internet security enabled for this Express Route Connection?
expressRouteGatewayBypassEnabled boolean
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
name Changes to this property will trigger replacement. string
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
privateLinkFastPathEnabled boolean

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing ExpressRouteConnectionRouting
A routing block as defined below.
routingWeight number
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
express_route_circuit_peering_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
express_route_gateway_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
authorization_key str
The authorization key to establish the Express Route Connection.
enable_internet_security bool
Is Internet security enabled for this Express Route Connection?
express_route_gateway_bypass_enabled bool
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
name Changes to this property will trigger replacement. str
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
private_link_fast_path_enabled bool

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing ExpressRouteConnectionRoutingArgs
A routing block as defined below.
routing_weight int
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
expressRouteCircuitPeeringId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
expressRouteGatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
authorizationKey String
The authorization key to establish the Express Route Connection.
enableInternetSecurity Boolean
Is Internet security enabled for this Express Route Connection?
expressRouteGatewayBypassEnabled Boolean
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
name Changes to this property will trigger replacement. String
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
privateLinkFastPathEnabled Boolean

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing Property Map
A routing block as defined below.
routingWeight Number
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ExpressRouteConnection Resource

Get an existing ExpressRouteConnection 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?: ExpressRouteConnectionState, opts?: CustomResourceOptions): ExpressRouteConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_key: Optional[str] = None,
        enable_internet_security: Optional[bool] = None,
        express_route_circuit_peering_id: Optional[str] = None,
        express_route_gateway_bypass_enabled: Optional[bool] = None,
        express_route_gateway_id: Optional[str] = None,
        name: Optional[str] = None,
        private_link_fast_path_enabled: Optional[bool] = None,
        routing: Optional[ExpressRouteConnectionRoutingArgs] = None,
        routing_weight: Optional[int] = None) -> ExpressRouteConnection
func GetExpressRouteConnection(ctx *Context, name string, id IDInput, state *ExpressRouteConnectionState, opts ...ResourceOption) (*ExpressRouteConnection, error)
public static ExpressRouteConnection Get(string name, Input<string> id, ExpressRouteConnectionState? state, CustomResourceOptions? opts = null)
public static ExpressRouteConnection get(String name, Output<String> id, ExpressRouteConnectionState state, CustomResourceOptions options)
resources:  _:    type: azure:network:ExpressRouteConnection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AuthorizationKey string
The authorization key to establish the Express Route Connection.
EnableInternetSecurity bool
Is Internet security enabled for this Express Route Connection?
ExpressRouteCircuitPeeringId Changes to this property will trigger replacement. string
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
ExpressRouteGatewayBypassEnabled bool
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
ExpressRouteGatewayId Changes to this property will trigger replacement. string
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
PrivateLinkFastPathEnabled bool

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

Routing ExpressRouteConnectionRouting
A routing block as defined below.
RoutingWeight int
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
AuthorizationKey string
The authorization key to establish the Express Route Connection.
EnableInternetSecurity bool
Is Internet security enabled for this Express Route Connection?
ExpressRouteCircuitPeeringId Changes to this property will trigger replacement. string
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
ExpressRouteGatewayBypassEnabled bool
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
ExpressRouteGatewayId Changes to this property will trigger replacement. string
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
PrivateLinkFastPathEnabled bool

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

Routing ExpressRouteConnectionRoutingArgs
A routing block as defined below.
RoutingWeight int
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
authorizationKey String
The authorization key to establish the Express Route Connection.
enableInternetSecurity Boolean
Is Internet security enabled for this Express Route Connection?
expressRouteCircuitPeeringId Changes to this property will trigger replacement. String
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
expressRouteGatewayBypassEnabled Boolean
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
expressRouteGatewayId Changes to this property will trigger replacement. String
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
privateLinkFastPathEnabled Boolean

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing ExpressRouteConnectionRouting
A routing block as defined below.
routingWeight Integer
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
authorizationKey string
The authorization key to establish the Express Route Connection.
enableInternetSecurity boolean
Is Internet security enabled for this Express Route Connection?
expressRouteCircuitPeeringId Changes to this property will trigger replacement. string
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
expressRouteGatewayBypassEnabled boolean
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
expressRouteGatewayId Changes to this property will trigger replacement. string
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
privateLinkFastPathEnabled boolean

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing ExpressRouteConnectionRouting
A routing block as defined below.
routingWeight number
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
authorization_key str
The authorization key to establish the Express Route Connection.
enable_internet_security bool
Is Internet security enabled for this Express Route Connection?
express_route_circuit_peering_id Changes to this property will trigger replacement. str
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
express_route_gateway_bypass_enabled bool
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
express_route_gateway_id Changes to this property will trigger replacement. str
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
private_link_fast_path_enabled bool

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing ExpressRouteConnectionRoutingArgs
A routing block as defined below.
routing_weight int
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.
authorizationKey String
The authorization key to establish the Express Route Connection.
enableInternetSecurity Boolean
Is Internet security enabled for this Express Route Connection?
expressRouteCircuitPeeringId Changes to this property will trigger replacement. String
The ID of the Express Route Circuit Peering that this Express Route Connection connects with. Changing this forces a new resource to be created.
expressRouteGatewayBypassEnabled Boolean
Specified whether Fast Path is enabled for Virtual Wan Firewall Hub. Defaults to false.
expressRouteGatewayId Changes to this property will trigger replacement. String
The ID of the Express Route Gateway that this Express Route Connection connects with. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Express Route Connection. Changing this forces a new resource to be created.
privateLinkFastPathEnabled Boolean

Deprecated: 'private_link_fast_path_enabled' has been deprecated as it is no longer supported by the resource and will be removed in v5.0 of the AzureRM Provider

routing Property Map
A routing block as defined below.
routingWeight Number
The routing weight associated to the Express Route Connection. Possible value is between 0 and 32000. Defaults to 0.

Supporting Types

ExpressRouteConnectionRouting
, ExpressRouteConnectionRoutingArgs

AssociatedRouteTableId string
The ID of the Virtual Hub Route Table associated with this Express Route Connection.
InboundRouteMapId string
The ID of the Route Map associated with this Express Route Connection for inbound routes.
OutboundRouteMapId string
The ID of the Route Map associated with this Express Route Connection for outbound routes.
PropagatedRouteTable ExpressRouteConnectionRoutingPropagatedRouteTable
A propagated_route_table block as defined below.
AssociatedRouteTableId string
The ID of the Virtual Hub Route Table associated with this Express Route Connection.
InboundRouteMapId string
The ID of the Route Map associated with this Express Route Connection for inbound routes.
OutboundRouteMapId string
The ID of the Route Map associated with this Express Route Connection for outbound routes.
PropagatedRouteTable ExpressRouteConnectionRoutingPropagatedRouteTable
A propagated_route_table block as defined below.
associatedRouteTableId String
The ID of the Virtual Hub Route Table associated with this Express Route Connection.
inboundRouteMapId String
The ID of the Route Map associated with this Express Route Connection for inbound routes.
outboundRouteMapId String
The ID of the Route Map associated with this Express Route Connection for outbound routes.
propagatedRouteTable ExpressRouteConnectionRoutingPropagatedRouteTable
A propagated_route_table block as defined below.
associatedRouteTableId string
The ID of the Virtual Hub Route Table associated with this Express Route Connection.
inboundRouteMapId string
The ID of the Route Map associated with this Express Route Connection for inbound routes.
outboundRouteMapId string
The ID of the Route Map associated with this Express Route Connection for outbound routes.
propagatedRouteTable ExpressRouteConnectionRoutingPropagatedRouteTable
A propagated_route_table block as defined below.
associated_route_table_id str
The ID of the Virtual Hub Route Table associated with this Express Route Connection.
inbound_route_map_id str
The ID of the Route Map associated with this Express Route Connection for inbound routes.
outbound_route_map_id str
The ID of the Route Map associated with this Express Route Connection for outbound routes.
propagated_route_table ExpressRouteConnectionRoutingPropagatedRouteTable
A propagated_route_table block as defined below.
associatedRouteTableId String
The ID of the Virtual Hub Route Table associated with this Express Route Connection.
inboundRouteMapId String
The ID of the Route Map associated with this Express Route Connection for inbound routes.
outboundRouteMapId String
The ID of the Route Map associated with this Express Route Connection for outbound routes.
propagatedRouteTable Property Map
A propagated_route_table block as defined below.

ExpressRouteConnectionRoutingPropagatedRouteTable
, ExpressRouteConnectionRoutingPropagatedRouteTableArgs

Labels List<string>
The list of labels to logically group route tables.
RouteTableIds List<string>
A list of IDs of the Virtual Hub Route Table to propagate routes from Express Route Connection to the route table.
Labels []string
The list of labels to logically group route tables.
RouteTableIds []string
A list of IDs of the Virtual Hub Route Table to propagate routes from Express Route Connection to the route table.
labels List<String>
The list of labels to logically group route tables.
routeTableIds List<String>
A list of IDs of the Virtual Hub Route Table to propagate routes from Express Route Connection to the route table.
labels string[]
The list of labels to logically group route tables.
routeTableIds string[]
A list of IDs of the Virtual Hub Route Table to propagate routes from Express Route Connection to the route table.
labels Sequence[str]
The list of labels to logically group route tables.
route_table_ids Sequence[str]
A list of IDs of the Virtual Hub Route Table to propagate routes from Express Route Connection to the route table.
labels List<String>
The list of labels to logically group route tables.
routeTableIds List<String>
A list of IDs of the Virtual Hub Route Table to propagate routes from Express Route Connection to the route table.

Import

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

$ pulumi import azure:network/expressRouteConnection:ExpressRouteConnection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/expressRouteGateways/expressRouteGateway1/expressRouteConnections/connection1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure