Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.6.0 published on Friday, May 20, 2022 by Pulumi

ExpressRouteCircuitPeering

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/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()        
            .resourceGroupName(exampleResourceGroup.getName())
            .location(exampleResourceGroup.getLocation())
            .serviceProviderName("Equinix")
            .peeringLocation("Silicon Valley")
            .bandwidthInMbps(50)
            .sku(ExpressRouteCircuitSku.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.getName())
            .resourceGroupName(exampleResourceGroup.getName())
            .peerAsn(100)
            .primaryPeerAddressPrefix("123.0.0.0/30")
            .secondaryPeerAddressPrefix("123.0.0.4/30")
            .vlanId(300)
            .microsoftPeeringConfig(ExpressRouteCircuitPeeringMicrosoftPeeringConfig.builder()
                .advertisedPublicPrefixes("123.1.0.0/24")
                .build())
            .ipv6(ExpressRouteCircuitPeeringIpv6.builder()
                .primaryPeerAddressPrefix("2002:db01::/126")
                .secondaryPeerAddressPrefix("2003:db01::/126")
                .microsoftPeering(ExpressRouteCircuitPeeringIpv6MicrosoftPeering.builder()
                    .advertisedPublicPrefixes("2002:db01::/126")
                    .build())
                .build())
            .build());

        }
}
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"],
        ),
    ))
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"],
        },
    },
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      serviceProviderName: Equinix
      peeringLocation: Silicon Valley
      bandwidthInMbps: 50
      sku:
        tier: Standard
        family: MeteredData
      allowClassicOperations: false
      tags:
        environment: Production
  exampleExpressRouteCircuitPeering:
    type: azure:network:ExpressRouteCircuitPeering
    properties:
      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

Create a ExpressRouteCircuitPeering Resource

new ExpressRouteCircuitPeering(name: string, args: ExpressRouteCircuitPeeringArgs, opts?: CustomResourceOptions);
@overload
def ExpressRouteCircuitPeering(resource_name: str,
                               opts: Optional[ResourceOptions] = 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_peer_address_prefix: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               route_filter_id: Optional[str] = None,
                               secondary_peer_address_prefix: Optional[str] = None,
                               shared_key: Optional[str] = None,
                               vlan_id: Optional[int] = None)
@overload
def ExpressRouteCircuitPeering(resource_name: str,
                               args: ExpressRouteCircuitPeeringArgs,
                               opts: Optional[ResourceOptions] = 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.

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.

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

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 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 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 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 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 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 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 an 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)
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.

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

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

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

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

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

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

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.