1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. ExpressRouteCircuitPeering

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.network.ExpressRouteCircuitPeering

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages an ExpressRoute Circuit Peering.

    Example Usage

    Creating A Microsoft Peering)

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("exampleExpressRouteCircuit", new Azure.Network.ExpressRouteCircuitArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            ServiceProviderName = "Equinix",
            PeeringLocation = "Silicon Valley",
            BandwidthInMbps = 50,
            Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
            {
                Tier = "Standard",
                Family = "MeteredData",
            },
            AllowClassicOperations = false,
            Tags = 
            {
                { "environment", "Production" },
            },
        });
        var exampleExpressRouteCircuitPeering = new Azure.Network.ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", new Azure.Network.ExpressRouteCircuitPeeringArgs
        {
            PeeringType = "MicrosoftPeering",
            ExpressRouteCircuitName = exampleExpressRouteCircuit.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            PeerAsn = 100,
            PrimaryPeerAddressPrefix = "123.0.0.0/30",
            SecondaryPeerAddressPrefix = "123.0.0.4/30",
            VlanId = 300,
            MicrosoftPeeringConfig = new Azure.Network.Inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
            {
                AdvertisedPublicPrefixes = 
                {
                    "123.1.0.0/24",
                },
            },
            Ipv6 = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6Args
            {
                PrimaryPeerAddressPrefix = "2002:db01::/126",
                SecondaryPeerAddressPrefix = "2003:db01::/126",
                MicrosoftPeering = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs
                {
                    AdvertisedPublicPrefixes = 
                    {
                        "2002:db01::/126",
                    },
                },
            },
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuit, err := network.NewExpressRouteCircuit(ctx, "exampleExpressRouteCircuit", &network.ExpressRouteCircuitArgs{
			ResourceGroupName:   exampleResourceGroup.Name,
			Location:            exampleResourceGroup.Location,
			ServiceProviderName: pulumi.String("Equinix"),
			PeeringLocation:     pulumi.String("Silicon Valley"),
			BandwidthInMbps:     pulumi.Int(50),
			Sku: &network.ExpressRouteCircuitSkuArgs{
				Tier:   pulumi.String("Standard"),
				Family: pulumi.String("MeteredData"),
			},
			AllowClassicOperations: pulumi.Bool(false),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		_, err = network.NewExpressRouteCircuitPeering(ctx, "exampleExpressRouteCircuitPeering", &network.ExpressRouteCircuitPeeringArgs{
			PeeringType:                pulumi.String("MicrosoftPeering"),
			ExpressRouteCircuitName:    exampleExpressRouteCircuit.Name,
			ResourceGroupName:          exampleResourceGroup.Name,
			PeerAsn:                    pulumi.Int(100),
			PrimaryPeerAddressPrefix:   pulumi.String("123.0.0.0/30"),
			SecondaryPeerAddressPrefix: pulumi.String("123.0.0.4/30"),
			VlanId:                     pulumi.Int(300),
			MicrosoftPeeringConfig: &network.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs{
				AdvertisedPublicPrefixes: pulumi.StringArray{
					pulumi.String("123.1.0.0/24"),
				},
			},
			Ipv6: &network.ExpressRouteCircuitPeeringIpv6Args{
				PrimaryPeerAddressPrefix:   pulumi.String("2002:db01::/126"),
				SecondaryPeerAddressPrefix: pulumi.String("2003:db01::/126"),
				MicrosoftPeering: &network.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs{
					AdvertisedPublicPrefixes: pulumi.StringArray{
						pulumi.String("2002:db01::/126"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    allowClassicOperations: false,
    tags: {
        environment: "Production",
    },
});
const exampleExpressRouteCircuitPeering = new azure.network.ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", {
    peeringType: "MicrosoftPeering",
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: exampleResourceGroup.name,
    peerAsn: 100,
    primaryPeerAddressPrefix: "123.0.0.0/30",
    secondaryPeerAddressPrefix: "123.0.0.4/30",
    vlanId: 300,
    microsoftPeeringConfig: {
        advertisedPublicPrefixes: ["123.1.0.0/24"],
    },
    ipv6: {
        primaryPeerAddressPrefix: "2002:db01::/126",
        secondaryPeerAddressPrefix: "2003:db01::/126",
        microsoftPeering: {
            advertisedPublicPrefixes: ["2002:db01::/126"],
        },
    },
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_express_route_circuit = azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku=azure.network.ExpressRouteCircuitSkuArgs(
        tier="Standard",
        family="MeteredData",
    ),
    allow_classic_operations=False,
    tags={
        "environment": "Production",
    })
example_express_route_circuit_peering = azure.network.ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering",
    peering_type="MicrosoftPeering",
    express_route_circuit_name=example_express_route_circuit.name,
    resource_group_name=example_resource_group.name,
    peer_asn=100,
    primary_peer_address_prefix="123.0.0.0/30",
    secondary_peer_address_prefix="123.0.0.4/30",
    vlan_id=300,
    microsoft_peering_config=azure.network.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs(
        advertised_public_prefixes=["123.1.0.0/24"],
    ),
    ipv6=azure.network.ExpressRouteCircuitPeeringIpv6Args(
        primary_peer_address_prefix="2002:db01::/126",
        secondary_peer_address_prefix="2003:db01::/126",
        microsoft_peering=azure.network.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs(
            advertised_public_prefixes=["2002:db01::/126"],
        ),
    ))

    Example coming soon!

    Create ExpressRouteCircuitPeering Resource

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

    Constructor syntax

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

@overload
def ExpressRouteCircuitPeering(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               express_route_circuit_name: Optional[str] = None,
                               peering_type: Optional[str] = None,
                               primary_peer_address_prefix: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               secondary_peer_address_prefix: Optional[str] = None,
                               vlan_id: Optional[int] = None,
                               ipv6: Optional[ExpressRouteCircuitPeeringIpv6Args] = None,
                               microsoft_peering_config: Optional[ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs] = None,
                               peer_asn: Optional[int] = None,
                               route_filter_id: Optional[str] = None,
                               shared_key: Optional[str] = None)
    func NewExpressRouteCircuitPeering(ctx *Context, name string, args ExpressRouteCircuitPeeringArgs, opts ...ResourceOption) (*ExpressRouteCircuitPeering, error)
    public ExpressRouteCircuitPeering(string name, ExpressRouteCircuitPeeringArgs args, CustomResourceOptions? opts = null)
    public ExpressRouteCircuitPeering(String name, ExpressRouteCircuitPeeringArgs args)
public ExpressRouteCircuitPeering(String name, ExpressRouteCircuitPeeringArgs args, CustomResourceOptions options)

    type: azure:network:ExpressRouteCircuitPeering
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 ExpressRouteCircuitPeeringArgs
    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 ExpressRouteCircuitPeeringArgs
    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 ExpressRouteCircuitPeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExpressRouteCircuitPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExpressRouteCircuitPeeringArgs
    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 expressRouteCircuitPeeringResource = new Azure.Network.ExpressRouteCircuitPeering("expressRouteCircuitPeeringResource", new()
{
    ExpressRouteCircuitName = "string",
    PeeringType = "string",
    PrimaryPeerAddressPrefix = "string",
    ResourceGroupName = "string",
    SecondaryPeerAddressPrefix = "string",
    VlanId = 0,
    Ipv6 = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6Args
    {
        MicrosoftPeering = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs
        {
            AdvertisedPublicPrefixes = new[]
            {
                "string",
            },
            CustomerAsn = 0,
            RoutingRegistryName = "string",
        },
        PrimaryPeerAddressPrefix = "string",
        SecondaryPeerAddressPrefix = "string",
        RouteFilterId = "string",
    },
    MicrosoftPeeringConfig = new Azure.Network.Inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
    {
        AdvertisedPublicPrefixes = new[]
        {
            "string",
        },
        CustomerAsn = 0,
        RoutingRegistryName = "string",
    },
    PeerAsn = 0,
    RouteFilterId = "string",
    SharedKey = "string",
});

    example, err := network.NewExpressRouteCircuitPeering(ctx, "expressRouteCircuitPeeringResource", &network.ExpressRouteCircuitPeeringArgs{
	ExpressRouteCircuitName:    pulumi.String("string"),
	PeeringType:                pulumi.String("string"),
	PrimaryPeerAddressPrefix:   pulumi.String("string"),
	ResourceGroupName:          pulumi.String("string"),
	SecondaryPeerAddressPrefix: pulumi.String("string"),
	VlanId:                     pulumi.Int(0),
	Ipv6: &network.ExpressRouteCircuitPeeringIpv6Args{
		MicrosoftPeering: &network.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs{
			AdvertisedPublicPrefixes: pulumi.StringArray{
				pulumi.String("string"),
			},
			CustomerAsn:         pulumi.Int(0),
			RoutingRegistryName: pulumi.String("string"),
		},
		PrimaryPeerAddressPrefix:   pulumi.String("string"),
		SecondaryPeerAddressPrefix: pulumi.String("string"),
		RouteFilterId:              pulumi.String("string"),
	},
	MicrosoftPeeringConfig: &network.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs{
		AdvertisedPublicPrefixes: pulumi.StringArray{
			pulumi.String("string"),
		},
		CustomerAsn:         pulumi.Int(0),
		RoutingRegistryName: pulumi.String("string"),
	},
	PeerAsn:       pulumi.Int(0),
	RouteFilterId: pulumi.String("string"),
	SharedKey:     pulumi.String("string"),
})

    var expressRouteCircuitPeeringResource = new ExpressRouteCircuitPeering("expressRouteCircuitPeeringResource", ExpressRouteCircuitPeeringArgs.builder()
    .expressRouteCircuitName("string")
    .peeringType("string")
    .primaryPeerAddressPrefix("string")
    .resourceGroupName("string")
    .secondaryPeerAddressPrefix("string")
    .vlanId(0)
    .ipv6(ExpressRouteCircuitPeeringIpv6Args.builder()
        .microsoftPeering(ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs.builder()
            .advertisedPublicPrefixes("string")
            .customerAsn(0)
            .routingRegistryName("string")
            .build())
        .primaryPeerAddressPrefix("string")
        .secondaryPeerAddressPrefix("string")
        .routeFilterId("string")
        .build())
    .microsoftPeeringConfig(ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs.builder()
        .advertisedPublicPrefixes("string")
        .customerAsn(0)
        .routingRegistryName("string")
        .build())
    .peerAsn(0)
    .routeFilterId("string")
    .sharedKey("string")
    .build());

    express_route_circuit_peering_resource = azure.network.ExpressRouteCircuitPeering("expressRouteCircuitPeeringResource",
    express_route_circuit_name="string",
    peering_type="string",
    primary_peer_address_prefix="string",
    resource_group_name="string",
    secondary_peer_address_prefix="string",
    vlan_id=0,
    ipv6={
        "microsoft_peering": {
            "advertised_public_prefixes": ["string"],
            "customer_asn": 0,
            "routing_registry_name": "string",
        },
        "primary_peer_address_prefix": "string",
        "secondary_peer_address_prefix": "string",
        "route_filter_id": "string",
    },
    microsoft_peering_config={
        "advertised_public_prefixes": ["string"],
        "customer_asn": 0,
        "routing_registry_name": "string",
    },
    peer_asn=0,
    route_filter_id="string",
    shared_key="string")

    const expressRouteCircuitPeeringResource = new azure.network.ExpressRouteCircuitPeering("expressRouteCircuitPeeringResource", {
    expressRouteCircuitName: "string",
    peeringType: "string",
    primaryPeerAddressPrefix: "string",
    resourceGroupName: "string",
    secondaryPeerAddressPrefix: "string",
    vlanId: 0,
    ipv6: {
        microsoftPeering: {
            advertisedPublicPrefixes: ["string"],
            customerAsn: 0,
            routingRegistryName: "string",
        },
        primaryPeerAddressPrefix: "string",
        secondaryPeerAddressPrefix: "string",
        routeFilterId: "string",
    },
    microsoftPeeringConfig: {
        advertisedPublicPrefixes: ["string"],
        customerAsn: 0,
        routingRegistryName: "string",
    },
    peerAsn: 0,
    routeFilterId: "string",
    sharedKey: "string",
});

    type: azure:network:ExpressRouteCircuitPeering
properties:
    expressRouteCircuitName: string
    ipv6:
        microsoftPeering:
            advertisedPublicPrefixes:
                - string
            customerAsn: 0
            routingRegistryName: string
        primaryPeerAddressPrefix: string
        routeFilterId: string
        secondaryPeerAddressPrefix: string
    microsoftPeeringConfig:
        advertisedPublicPrefixes:
            - string
        customerAsn: 0
        routingRegistryName: string
    peerAsn: 0
    peeringType: string
    primaryPeerAddressPrefix: string
    resourceGroupName: string
    routeFilterId: string
    secondaryPeerAddressPrefix: string
    sharedKey: string
    vlanId: 0

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

    ExpressRouteCircuitName string
    The name of the ExpressRoute Circuit in which to create the Peering.
    PeeringType string
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    ResourceGroupName string
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    VlanId int
    A valid VLAN ID to establish this peering on.
    Ipv6 ExpressRouteCircuitPeeringIpv6
    A ipv6 block as defined below.
    MicrosoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    PeerAsn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    RouteFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    SharedKey string
    The shared key. Can be a maximum of 25 characters.
    ExpressRouteCircuitName string
    The name of the ExpressRoute Circuit in which to create the Peering.
    PeeringType string
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    ResourceGroupName string
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    VlanId int
    A valid VLAN ID to establish this peering on.
    Ipv6 ExpressRouteCircuitPeeringIpv6Args
    A ipv6 block as defined below.
    MicrosoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    PeerAsn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    RouteFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    SharedKey string
    The shared key. Can be a maximum of 25 characters.
    expressRouteCircuitName String
    The name of the ExpressRoute Circuit in which to create the Peering.
    peeringType String
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    resourceGroupName String
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    vlanId Integer
    A valid VLAN ID to establish this peering on.
    ipv6 ExpressRouteCircuitPeeringIpv6
    A ipv6 block as defined below.
    microsoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peerAsn Integer
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    routeFilterId String
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    sharedKey String
    The shared key. Can be a maximum of 25 characters.
    expressRouteCircuitName string
    The name of the ExpressRoute Circuit in which to create the Peering.
    peeringType string
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primaryPeerAddressPrefix string
    A subnet for the primary link.
    resourceGroupName string
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    secondaryPeerAddressPrefix string
    A subnet for the secondary link.
    vlanId number
    A valid VLAN ID to establish this peering on.
    ipv6 ExpressRouteCircuitPeeringIpv6
    A ipv6 block as defined below.
    microsoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peerAsn number
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    routeFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    sharedKey string
    The shared key. Can be a maximum of 25 characters.
    express_route_circuit_name str
    The name of the ExpressRoute Circuit in which to create the Peering.
    peering_type str
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primary_peer_address_prefix str
    A subnet for the primary link.
    resource_group_name str
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    secondary_peer_address_prefix str
    A subnet for the secondary link.
    vlan_id int
    A valid VLAN ID to establish this peering on.
    ipv6 ExpressRouteCircuitPeeringIpv6Args
    A ipv6 block as defined below.
    microsoft_peering_config ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peer_asn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    route_filter_id str
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    shared_key str
    The shared key. Can be a maximum of 25 characters.
    expressRouteCircuitName String
    The name of the ExpressRoute Circuit in which to create the Peering.
    peeringType String
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    resourceGroupName String
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    vlanId Number
    A valid VLAN ID to establish this peering on.
    ipv6 Property Map
    A ipv6 block as defined below.
    microsoftPeeringConfig Property Map
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peerAsn Number
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    routeFilterId String
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    sharedKey String
    The shared key. Can be a maximum of 25 characters.

    Outputs

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

    AzureAsn int
    The ASN used by Azure.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAzurePort string
    The Primary Port used by Azure for this Peering.
    SecondaryAzurePort string
    The Secondary Port used by Azure for this Peering.
    AzureAsn int
    The ASN used by Azure.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAzurePort string
    The Primary Port used by Azure for this Peering.
    SecondaryAzurePort string
    The Secondary Port used by Azure for this Peering.
    azureAsn Integer
    The ASN used by Azure.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAzurePort String
    The Primary Port used by Azure for this Peering.
    secondaryAzurePort String
    The Secondary Port used by Azure for this Peering.
    azureAsn number
    The ASN used by Azure.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryAzurePort string
    The Primary Port used by Azure for this Peering.
    secondaryAzurePort string
    The Secondary Port used by Azure for this Peering.
    azure_asn int
    The ASN used by Azure.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_azure_port str
    The Primary Port used by Azure for this Peering.
    secondary_azure_port str
    The Secondary Port used by Azure for this Peering.
    azureAsn Number
    The ASN used by Azure.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAzurePort String
    The Primary Port used by Azure for this Peering.
    secondaryAzurePort String
    The Secondary Port used by Azure for this Peering.

    Look up Existing ExpressRouteCircuitPeering Resource

    Get an existing ExpressRouteCircuitPeering 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?: ExpressRouteCircuitPeeringState, opts?: CustomResourceOptions): ExpressRouteCircuitPeering
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        azure_asn: Optional[int] = None,
        express_route_circuit_name: Optional[str] = None,
        ipv6: Optional[ExpressRouteCircuitPeeringIpv6Args] = None,
        microsoft_peering_config: Optional[ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs] = None,
        peer_asn: Optional[int] = None,
        peering_type: Optional[str] = None,
        primary_azure_port: Optional[str] = None,
        primary_peer_address_prefix: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        route_filter_id: Optional[str] = None,
        secondary_azure_port: Optional[str] = None,
        secondary_peer_address_prefix: Optional[str] = None,
        shared_key: Optional[str] = None,
        vlan_id: Optional[int] = None) -> ExpressRouteCircuitPeering
    func GetExpressRouteCircuitPeering(ctx *Context, name string, id IDInput, state *ExpressRouteCircuitPeeringState, opts ...ResourceOption) (*ExpressRouteCircuitPeering, error)
    public static ExpressRouteCircuitPeering Get(string name, Input<string> id, ExpressRouteCircuitPeeringState? state, CustomResourceOptions? opts = null)
    public static ExpressRouteCircuitPeering get(String name, Output<String> id, ExpressRouteCircuitPeeringState state, CustomResourceOptions options)
    resources:  _:    type: azure:network:ExpressRouteCircuitPeering    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:
    AzureAsn int
    The ASN used by Azure.
    ExpressRouteCircuitName string
    The name of the ExpressRoute Circuit in which to create the Peering.
    Ipv6 ExpressRouteCircuitPeeringIpv6
    A ipv6 block as defined below.
    MicrosoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    PeerAsn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    PeeringType string
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    PrimaryAzurePort string
    The Primary Port used by Azure for this Peering.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    ResourceGroupName string
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    RouteFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    SecondaryAzurePort string
    The Secondary Port used by Azure for this Peering.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    SharedKey string
    The shared key. Can be a maximum of 25 characters.
    VlanId int
    A valid VLAN ID to establish this peering on.
    AzureAsn int
    The ASN used by Azure.
    ExpressRouteCircuitName string
    The name of the ExpressRoute Circuit in which to create the Peering.
    Ipv6 ExpressRouteCircuitPeeringIpv6Args
    A ipv6 block as defined below.
    MicrosoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    PeerAsn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    PeeringType string
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    PrimaryAzurePort string
    The Primary Port used by Azure for this Peering.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    ResourceGroupName string
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    RouteFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    SecondaryAzurePort string
    The Secondary Port used by Azure for this Peering.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    SharedKey string
    The shared key. Can be a maximum of 25 characters.
    VlanId int
    A valid VLAN ID to establish this peering on.
    azureAsn Integer
    The ASN used by Azure.
    expressRouteCircuitName String
    The name of the ExpressRoute Circuit in which to create the Peering.
    ipv6 ExpressRouteCircuitPeeringIpv6
    A ipv6 block as defined below.
    microsoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peerAsn Integer
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    peeringType String
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primaryAzurePort String
    The Primary Port used by Azure for this Peering.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    resourceGroupName String
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    routeFilterId String
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    secondaryAzurePort String
    The Secondary Port used by Azure for this Peering.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    sharedKey String
    The shared key. Can be a maximum of 25 characters.
    vlanId Integer
    A valid VLAN ID to establish this peering on.
    azureAsn number
    The ASN used by Azure.
    expressRouteCircuitName string
    The name of the ExpressRoute Circuit in which to create the Peering.
    ipv6 ExpressRouteCircuitPeeringIpv6
    A ipv6 block as defined below.
    microsoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peerAsn number
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    peeringType string
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primaryAzurePort string
    The Primary Port used by Azure for this Peering.
    primaryPeerAddressPrefix string
    A subnet for the primary link.
    resourceGroupName string
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    routeFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    secondaryAzurePort string
    The Secondary Port used by Azure for this Peering.
    secondaryPeerAddressPrefix string
    A subnet for the secondary link.
    sharedKey string
    The shared key. Can be a maximum of 25 characters.
    vlanId number
    A valid VLAN ID to establish this peering on.
    azure_asn int
    The ASN used by Azure.
    express_route_circuit_name str
    The name of the ExpressRoute Circuit in which to create the Peering.
    ipv6 ExpressRouteCircuitPeeringIpv6Args
    A ipv6 block as defined below.
    microsoft_peering_config ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peer_asn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    peering_type str
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primary_azure_port str
    The Primary Port used by Azure for this Peering.
    primary_peer_address_prefix str
    A subnet for the primary link.
    resource_group_name str
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    route_filter_id str
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    secondary_azure_port str
    The Secondary Port used by Azure for this Peering.
    secondary_peer_address_prefix str
    A subnet for the secondary link.
    shared_key str
    The shared key. Can be a maximum of 25 characters.
    vlan_id int
    A valid VLAN ID to establish this peering on.
    azureAsn Number
    The ASN used by Azure.
    expressRouteCircuitName String
    The name of the ExpressRoute Circuit in which to create the Peering.
    ipv6 Property Map
    A ipv6 block as defined below.
    microsoftPeeringConfig Property Map
    A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
    peerAsn Number
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    peeringType String
    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
    primaryAzurePort String
    The Primary Port used by Azure for this Peering.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    resourceGroupName String
    The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
    routeFilterId String
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    secondaryAzurePort String
    The Secondary Port used by Azure for this Peering.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    sharedKey String
    The shared key. Can be a maximum of 25 characters.
    vlanId Number
    A valid VLAN ID to establish this peering on.

    Supporting Types

    ExpressRouteCircuitPeeringIpv6, ExpressRouteCircuitPeeringIpv6Args

    MicrosoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    RouteFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    MicrosoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    RouteFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    microsoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    routeFilterId String
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    microsoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    primaryPeerAddressPrefix string
    A subnet for the primary link.
    secondaryPeerAddressPrefix string
    A subnet for the secondary link.
    routeFilterId string
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    microsoft_peering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    primary_peer_address_prefix str
    A subnet for the primary link.
    secondary_peer_address_prefix str
    A subnet for the secondary link.
    route_filter_id str
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.
    microsoftPeering Property Map
    A microsoft_peering block as defined below.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    routeFilterId String
    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    ExpressRouteCircuitPeeringIpv6MicrosoftPeering, ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs

    AdvertisedPublicPrefixes List<string>
    A list of Advertised Public Prefixes.
    CustomerAsn int
    The CustomerASN of the peering.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    AdvertisedPublicPrefixes []string
    A list of Advertised Public Prefixes.
    CustomerAsn int
    The CustomerASN of the peering.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    customerAsn Integer
    The CustomerASN of the peering.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertisedPublicPrefixes string[]
    A list of Advertised Public Prefixes.
    customerAsn number
    The CustomerASN of the peering.
    routingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertised_public_prefixes Sequence[str]
    A list of Advertised Public Prefixes.
    customer_asn int
    The CustomerASN of the peering.
    routing_registry_name str
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    customerAsn Number
    The CustomerASN of the peering.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.

    ExpressRouteCircuitPeeringMicrosoftPeeringConfig, ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs

    AdvertisedPublicPrefixes List<string>
    A list of Advertised Public Prefixes.
    CustomerAsn int
    The CustomerASN of the peering.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    AdvertisedPublicPrefixes []string
    A list of Advertised Public Prefixes.
    CustomerAsn int
    The CustomerASN of the peering.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    customerAsn Integer
    The CustomerASN of the peering.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertisedPublicPrefixes string[]
    A list of Advertised Public Prefixes.
    customerAsn number
    The CustomerASN of the peering.
    routingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertised_public_prefixes Sequence[str]
    A list of Advertised Public Prefixes.
    customer_asn int
    The CustomerASN of the peering.
    routing_registry_name str
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    customerAsn Number
    The CustomerASN of the peering.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc.

    Import

    ExpressRoute Circuit Peerings can be imported using the resource id, e.g.

     $ pulumi import azure:network/expressRouteCircuitPeering:ExpressRouteCircuitPeering peering1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/expressRouteCircuits/myExpressRoute/peerings/peering1

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.