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

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.network.ExpressRouteCircuitPeering

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an ExpressRoute Circuit Peering.

    Example Usage

    Creating A Microsoft Peering)

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

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

    import pulumi
import pulumi_azure as azure

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

    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("exprtTest"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuit, err := network.NewExpressRouteCircuit(ctx, "example", &network.ExpressRouteCircuitArgs{
			Name:                pulumi.String("expressRoute1"),
			ResourceGroupName:   example.Name,
			Location:            example.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, "example", &network.ExpressRouteCircuitPeeringArgs{
			PeeringType:                pulumi.String("MicrosoftPeering"),
			ExpressRouteCircuitName:    exampleExpressRouteCircuit.Name,
			ResourceGroupName:          example.Name,
			PeerAsn:                    pulumi.Int(100),
			PrimaryPeerAddressPrefix:   pulumi.String("123.0.0.0/30"),
			SecondaryPeerAddressPrefix: pulumi.String("123.0.0.4/30"),
			Ipv4Enabled:                pulumi.Bool(true),
			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"),
				Enabled:                    pulumi.Bool(true),
				MicrosoftPeering: &network.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs{
					AdvertisedPublicPrefixes: pulumi.StringArray{
						pulumi.String("2002:db01::/126"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "exprtTest",
        Location = "West Europe",
    });

    var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("example", new()
    {
        Name = "expressRoute1",
        ResourceGroupName = example.Name,
        Location = example.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("example", new()
    {
        PeeringType = "MicrosoftPeering",
        ExpressRouteCircuitName = exampleExpressRouteCircuit.Name,
        ResourceGroupName = example.Name,
        PeerAsn = 100,
        PrimaryPeerAddressPrefix = "123.0.0.0/30",
        SecondaryPeerAddressPrefix = "123.0.0.4/30",
        Ipv4Enabled = true,
        VlanId = 300,
        MicrosoftPeeringConfig = new Azure.Network.Inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
        {
            AdvertisedPublicPrefixes = new[]
            {
                "123.1.0.0/24",
            },
        },
        Ipv6 = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6Args
        {
            PrimaryPeerAddressPrefix = "2002:db01::/126",
            SecondaryPeerAddressPrefix = "2003:db01::/126",
            Enabled = true,
            MicrosoftPeering = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs
            {
                AdvertisedPublicPrefixes = new[]
                {
                    "2002:db01::/126",
                },
            },
        },
    });

});

    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.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.inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitPeeringIpv6Args;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs;
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("exprtTest")
            .location("West Europe")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()
            .name("expressRoute1")
            .resourceGroupName(example.name())
            .location(example.location())
            .serviceProviderName("Equinix")
            .peeringLocation("Silicon Valley")
            .bandwidthInMbps(50)
            .sku(ExpressRouteCircuitSkuArgs.builder()
                .tier("Standard")
                .family("MeteredData")
                .build())
            .allowClassicOperations(false)
            .tags(Map.of("environment", "Production"))
            .build());

        var exampleExpressRouteCircuitPeering = new ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", ExpressRouteCircuitPeeringArgs.builder()
            .peeringType("MicrosoftPeering")
            .expressRouteCircuitName(exampleExpressRouteCircuit.name())
            .resourceGroupName(example.name())
            .peerAsn(100)
            .primaryPeerAddressPrefix("123.0.0.0/30")
            .secondaryPeerAddressPrefix("123.0.0.4/30")
            .ipv4Enabled(true)
            .vlanId(300)
            .microsoftPeeringConfig(ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs.builder()
                .advertisedPublicPrefixes("123.1.0.0/24")
                .build())
            .ipv6(ExpressRouteCircuitPeeringIpv6Args.builder()
                .primaryPeerAddressPrefix("2002:db01::/126")
                .secondaryPeerAddressPrefix("2003:db01::/126")
                .enabled(true)
                .microsoftPeering(ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs.builder()
                    .advertisedPublicPrefixes("2002:db01::/126")
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: exprtTest
      location: West Europe
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    name: example
    properties:
      name: expressRoute1
      resourceGroupName: ${example.name}
      location: ${example.location}
      serviceProviderName: Equinix
      peeringLocation: Silicon Valley
      bandwidthInMbps: 50
      sku:
        tier: Standard
        family: MeteredData
      allowClassicOperations: false
      tags:
        environment: Production
  exampleExpressRouteCircuitPeering:
    type: azure:network:ExpressRouteCircuitPeering
    name: example
    properties:
      peeringType: MicrosoftPeering
      expressRouteCircuitName: ${exampleExpressRouteCircuit.name}
      resourceGroupName: ${example.name}
      peerAsn: 100
      primaryPeerAddressPrefix: 123.0.0.0/30
      secondaryPeerAddressPrefix: 123.0.0.4/30
      ipv4Enabled: true
      vlanId: 300
      microsoftPeeringConfig:
        advertisedPublicPrefixes:
          - 123.1.0.0/24
      ipv6:
        primaryPeerAddressPrefix: 2002:db01::/126
        secondaryPeerAddressPrefix: 2003:db01::/126
        enabled: true
        microsoftPeering:
          advertisedPublicPrefixes:
            - 2002:db01::/126

    Creating Azure Private Peering)

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

const example = new azure.core.ResourceGroup("example", {
    name: "exprtTest",
    location: "West Europe",
});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("example", {
    name: "expressRoute1",
    resourceGroupName: example.name,
    location: example.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    allowClassicOperations: false,
    tags: {
        environment: "Production",
    },
});
const exampleExpressRouteCircuitPeering = new azure.network.ExpressRouteCircuitPeering("example", {
    peeringType: "AzurePrivatePeering",
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: example.name,
    peerAsn: 100,
    primaryPeerAddressPrefix: "123.0.0.0/30",
    secondaryPeerAddressPrefix: "123.0.0.4/30",
    ipv4Enabled: true,
    vlanId: 300,
    ipv6: {
        primaryPeerAddressPrefix: "2002:db01::/126",
        secondaryPeerAddressPrefix: "2003:db01::/126",
        enabled: true,
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="exprtTest",
    location="West Europe")
example_express_route_circuit = azure.network.ExpressRouteCircuit("example",
    name="expressRoute1",
    resource_group_name=example.name,
    location=example.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    allow_classic_operations=False,
    tags={
        "environment": "Production",
    })
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,
    peer_asn=100,
    primary_peer_address_prefix="123.0.0.0/30",
    secondary_peer_address_prefix="123.0.0.4/30",
    ipv4_enabled=True,
    vlan_id=300,
    ipv6={
        "primary_peer_address_prefix": "2002:db01::/126",
        "secondary_peer_address_prefix": "2003:db01::/126",
        "enabled": True,
    })

    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("exprtTest"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleExpressRouteCircuit, err := network.NewExpressRouteCircuit(ctx, "example", &network.ExpressRouteCircuitArgs{
			Name:                pulumi.String("expressRoute1"),
			ResourceGroupName:   example.Name,
			Location:            example.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, "example", &network.ExpressRouteCircuitPeeringArgs{
			PeeringType:                pulumi.String("AzurePrivatePeering"),
			ExpressRouteCircuitName:    exampleExpressRouteCircuit.Name,
			ResourceGroupName:          example.Name,
			PeerAsn:                    pulumi.Int(100),
			PrimaryPeerAddressPrefix:   pulumi.String("123.0.0.0/30"),
			SecondaryPeerAddressPrefix: pulumi.String("123.0.0.4/30"),
			Ipv4Enabled:                pulumi.Bool(true),
			VlanId:                     pulumi.Int(300),
			Ipv6: &network.ExpressRouteCircuitPeeringIpv6Args{
				PrimaryPeerAddressPrefix:   pulumi.String("2002:db01::/126"),
				SecondaryPeerAddressPrefix: pulumi.String("2003:db01::/126"),
				Enabled:                    pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "exprtTest",
        Location = "West Europe",
    });

    var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("example", new()
    {
        Name = "expressRoute1",
        ResourceGroupName = example.Name,
        Location = example.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("example", new()
    {
        PeeringType = "AzurePrivatePeering",
        ExpressRouteCircuitName = exampleExpressRouteCircuit.Name,
        ResourceGroupName = example.Name,
        PeerAsn = 100,
        PrimaryPeerAddressPrefix = "123.0.0.0/30",
        SecondaryPeerAddressPrefix = "123.0.0.4/30",
        Ipv4Enabled = true,
        VlanId = 300,
        Ipv6 = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6Args
        {
            PrimaryPeerAddressPrefix = "2002:db01::/126",
            SecondaryPeerAddressPrefix = "2003:db01::/126",
            Enabled = true,
        },
    });

});

    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.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.inputs.ExpressRouteCircuitPeeringIpv6Args;
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("exprtTest")
            .location("West Europe")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()
            .name("expressRoute1")
            .resourceGroupName(example.name())
            .location(example.location())
            .serviceProviderName("Equinix")
            .peeringLocation("Silicon Valley")
            .bandwidthInMbps(50)
            .sku(ExpressRouteCircuitSkuArgs.builder()
                .tier("Standard")
                .family("MeteredData")
                .build())
            .allowClassicOperations(false)
            .tags(Map.of("environment", "Production"))
            .build());

        var exampleExpressRouteCircuitPeering = new ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", ExpressRouteCircuitPeeringArgs.builder()
            .peeringType("AzurePrivatePeering")
            .expressRouteCircuitName(exampleExpressRouteCircuit.name())
            .resourceGroupName(example.name())
            .peerAsn(100)
            .primaryPeerAddressPrefix("123.0.0.0/30")
            .secondaryPeerAddressPrefix("123.0.0.4/30")
            .ipv4Enabled(true)
            .vlanId(300)
            .ipv6(ExpressRouteCircuitPeeringIpv6Args.builder()
                .primaryPeerAddressPrefix("2002:db01::/126")
                .secondaryPeerAddressPrefix("2003:db01::/126")
                .enabled(true)
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: exprtTest
      location: West Europe
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    name: example
    properties:
      name: expressRoute1
      resourceGroupName: ${example.name}
      location: ${example.location}
      serviceProviderName: Equinix
      peeringLocation: Silicon Valley
      bandwidthInMbps: 50
      sku:
        tier: Standard
        family: MeteredData
      allowClassicOperations: false
      tags:
        environment: Production
  exampleExpressRouteCircuitPeering:
    type: azure:network:ExpressRouteCircuitPeering
    name: example
    properties:
      peeringType: AzurePrivatePeering
      expressRouteCircuitName: ${exampleExpressRouteCircuit.name}
      resourceGroupName: ${example.name}
      peerAsn: 100
      primaryPeerAddressPrefix: 123.0.0.0/30
      secondaryPeerAddressPrefix: 123.0.0.4/30
      ipv4Enabled: true
      vlanId: 300
      ipv6:
        primaryPeerAddressPrefix: 2002:db01::/126
        secondaryPeerAddressPrefix: 2003:db01::/126
        enabled: true

    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,
                               resource_group_name: Optional[str] = None,
                               vlan_id: Optional[int] = None,
                               ipv4_enabled: Optional[bool] = None,
                               ipv6: Optional[ExpressRouteCircuitPeeringIpv6Args] = None,
                               microsoft_peering_config: Optional[ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs] = None,
                               peer_asn: Optional[int] = None,
                               primary_peer_address_prefix: Optional[str] = None,
                               route_filter_id: Optional[str] = None,
                               secondary_peer_address_prefix: 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",
    ResourceGroupName = "string",
    VlanId = 0,
    Ipv4Enabled = false,
    Ipv6 = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6Args
    {
        PrimaryPeerAddressPrefix = "string",
        SecondaryPeerAddressPrefix = "string",
        Enabled = false,
        MicrosoftPeering = new Azure.Network.Inputs.ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs
        {
            AdvertisedCommunities = new[]
            {
                "string",
            },
            AdvertisedPublicPrefixes = new[]
            {
                "string",
            },
            CustomerAsn = 0,
            RoutingRegistryName = "string",
        },
        RouteFilterId = "string",
    },
    MicrosoftPeeringConfig = new Azure.Network.Inputs.ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs
    {
        AdvertisedPublicPrefixes = new[]
        {
            "string",
        },
        AdvertisedCommunities = new[]
        {
            "string",
        },
        CustomerAsn = 0,
        RoutingRegistryName = "string",
    },
    PeerAsn = 0,
    PrimaryPeerAddressPrefix = "string",
    RouteFilterId = "string",
    SecondaryPeerAddressPrefix = "string",
    SharedKey = "string",
});

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

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

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

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

    type: azure:network:ExpressRouteCircuitPeering
properties:
    expressRouteCircuitName: string
    ipv4Enabled: false
    ipv6:
        enabled: false
        microsoftPeering:
            advertisedCommunities:
                - string
            advertisedPublicPrefixes:
                - string
            customerAsn: 0
            routingRegistryName: string
        primaryPeerAddressPrefix: string
        routeFilterId: string
        secondaryPeerAddressPrefix: string
    microsoftPeeringConfig:
        advertisedCommunities:
            - string
        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. Changing this forces a new resource to be created.
    PeeringType string

    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.
    VlanId int
    A valid VLAN ID to establish this peering on.
    Ipv4Enabled bool
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    PeerAsn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    RouteFilterId string

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    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. Changing this forces a new resource to be created.
    PeeringType string

    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.
    VlanId int
    A valid VLAN ID to establish this peering on.
    Ipv4Enabled bool
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    PeerAsn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    RouteFilterId string

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    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. Changing this forces a new resource to be created.
    peeringType String

    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.
    vlanId Integer
    A valid VLAN ID to establish this peering on.
    ipv4Enabled Boolean
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    peerAsn Integer
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    routeFilterId String

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    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. Changing this forces a new resource to be created.
    peeringType string

    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.
    vlanId number
    A valid VLAN ID to establish this peering on.
    ipv4Enabled boolean
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    peerAsn number
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    primaryPeerAddressPrefix string
    A subnet for the primary link.
    routeFilterId string

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    secondaryPeerAddressPrefix string
    A subnet for the secondary link.
    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. Changing this forces a new resource to be created.
    peering_type str

    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.
    vlan_id int
    A valid VLAN ID to establish this peering on.
    ipv4_enabled bool
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    peer_asn int
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    primary_peer_address_prefix str
    A subnet for the primary link.
    route_filter_id str

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    secondary_peer_address_prefix str
    A subnet for the secondary link.
    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. Changing this forces a new resource to be created.
    peeringType String

    The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.
    vlanId Number
    A valid VLAN ID to establish this peering on.
    ipv4Enabled Boolean
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    peerAsn Number
    The Either a 16-bit or a 32-bit ASN. Can either be public or private.
    primaryPeerAddressPrefix String
    A subnet for the primary link.
    routeFilterId String

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    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.
    GatewayManagerEtag string
    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.
    GatewayManagerEtag string
    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.
    gatewayManagerEtag String
    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.
    gatewayManagerEtag string
    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.
    gateway_manager_etag str
    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.
    gatewayManagerEtag String
    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,
        gateway_manager_etag: Optional[str] = None,
        ipv4_enabled: Optional[bool] = 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)
    Resource lookup is not supported in YAML
    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. Changing this forces a new resource to be created.
    GatewayManagerEtag string
    Ipv4Enabled bool
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    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.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    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. Changing this forces a new resource to be created.
    GatewayManagerEtag string
    Ipv4Enabled bool
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    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.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    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. Changing this forces a new resource to be created.
    gatewayManagerEtag String
    ipv4Enabled Boolean
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    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.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    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. Changing this forces a new resource to be created.
    gatewayManagerEtag string
    ipv4Enabled boolean
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    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.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    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. Changing this forces a new resource to be created.
    gateway_manager_etag str
    ipv4_enabled bool
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    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.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    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. Changing this forces a new resource to be created.
    gatewayManagerEtag String
    ipv4Enabled Boolean
    A boolean value indicating whether the IPv4 peering is enabled. Defaults to true.
    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 and config for IPv4.
    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.

    NOTE: only one Peering of each Type can be created. Attempting to create multiple peerings of the same type will overwrite the original peering.

    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.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    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

    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    Enabled bool
    A boolean value indicating whether the IPv6 peering is enabled. Defaults to true.
    MicrosoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    RouteFilterId string

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    PrimaryPeerAddressPrefix string
    A subnet for the primary link.
    SecondaryPeerAddressPrefix string
    A subnet for the secondary link.
    Enabled bool
    A boolean value indicating whether the IPv6 peering is enabled. Defaults to true.
    MicrosoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    RouteFilterId string

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    primaryPeerAddressPrefix String
    A subnet for the primary link.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    enabled Boolean
    A boolean value indicating whether the IPv6 peering is enabled. Defaults to true.
    microsoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    routeFilterId String

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    primaryPeerAddressPrefix string
    A subnet for the primary link.
    secondaryPeerAddressPrefix string
    A subnet for the secondary link.
    enabled boolean
    A boolean value indicating whether the IPv6 peering is enabled. Defaults to true.
    microsoftPeering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    routeFilterId string

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    primary_peer_address_prefix str
    A subnet for the primary link.
    secondary_peer_address_prefix str
    A subnet for the secondary link.
    enabled bool
    A boolean value indicating whether the IPv6 peering is enabled. Defaults to true.
    microsoft_peering ExpressRouteCircuitPeeringIpv6MicrosoftPeering
    A microsoft_peering block as defined below.
    route_filter_id str

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    primaryPeerAddressPrefix String
    A subnet for the primary link.
    secondaryPeerAddressPrefix String
    A subnet for the secondary link.
    enabled Boolean
    A boolean value indicating whether the IPv6 peering is enabled. Defaults to true.
    microsoftPeering Property Map
    A microsoft_peering block as defined below.
    routeFilterId String

    The ID of the Route Filter. Only available when peering_type is set to MicrosoftPeering.

    NOTE: ipv6 can be specified when peering_type is MicrosoftPeering or AzurePrivatePeering

    ExpressRouteCircuitPeeringIpv6MicrosoftPeering, ExpressRouteCircuitPeeringIpv6MicrosoftPeeringArgs

    AdvertisedCommunities List<string>
    The communities of Bgp Peering specified for microsoft peering.
    AdvertisedPublicPrefixes List<string>
    A list of Advertised Public Prefixes.
    CustomerAsn int
    The CustomerASN of the peering. Defaults to 0.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    AdvertisedCommunities []string
    The communities of Bgp Peering specified for microsoft peering.
    AdvertisedPublicPrefixes []string
    A list of Advertised Public Prefixes.
    CustomerAsn int
    The CustomerASN of the peering. Defaults to 0.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertisedCommunities List<String>
    The communities of Bgp Peering specified for microsoft peering.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    customerAsn Integer
    The CustomerASN of the peering. Defaults to 0.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertisedCommunities string[]
    The communities of Bgp Peering specified for microsoft peering.
    advertisedPublicPrefixes string[]
    A list of Advertised Public Prefixes.
    customerAsn number
    The CustomerASN of the peering. Defaults to 0.
    routingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertised_communities Sequence[str]
    The communities of Bgp Peering specified for microsoft peering.
    advertised_public_prefixes Sequence[str]
    A list of Advertised Public Prefixes.
    customer_asn int
    The CustomerASN of the peering. Defaults to 0.
    routing_registry_name str
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertisedCommunities List<String>
    The communities of Bgp Peering specified for microsoft peering.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    customerAsn Number
    The CustomerASN of the peering. Defaults to 0.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.

    ExpressRouteCircuitPeeringMicrosoftPeeringConfig, ExpressRouteCircuitPeeringMicrosoftPeeringConfigArgs

    AdvertisedPublicPrefixes List<string>
    A list of Advertised Public Prefixes.
    AdvertisedCommunities List<string>
    The communities of Bgp Peering specified for microsoft peering.
    CustomerAsn int
    The CustomerASN of the peering. Defaults to 0.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    AdvertisedPublicPrefixes []string
    A list of Advertised Public Prefixes.
    AdvertisedCommunities []string
    The communities of Bgp Peering specified for microsoft peering.
    CustomerAsn int
    The CustomerASN of the peering. Defaults to 0.
    RoutingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    advertisedCommunities List<String>
    The communities of Bgp Peering specified for microsoft peering.
    customerAsn Integer
    The CustomerASN of the peering. Defaults to 0.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertisedPublicPrefixes string[]
    A list of Advertised Public Prefixes.
    advertisedCommunities string[]
    The communities of Bgp Peering specified for microsoft peering.
    customerAsn number
    The CustomerASN of the peering. Defaults to 0.
    routingRegistryName string
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertised_public_prefixes Sequence[str]
    A list of Advertised Public Prefixes.
    advertised_communities Sequence[str]
    The communities of Bgp Peering specified for microsoft peering.
    customer_asn int
    The CustomerASN of the peering. Defaults to 0.
    routing_registry_name str
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.
    advertisedPublicPrefixes List<String>
    A list of Advertised Public Prefixes.
    advertisedCommunities List<String>
    The communities of Bgp Peering specified for microsoft peering.
    customerAsn Number
    The CustomerASN of the peering. Defaults to 0.
    routingRegistryName String
    The Routing Registry against which the AS number and prefixes are registered. For example: ARIN, RIPE, AFRINIC etc. Defaults to NONE.

    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.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure