ExpressRouteCircuitPeering

Manages an ExpressRoute Circuit Peering.

Create a ExpressRouteCircuitPeering Resource

new ExpressRouteCircuitPeering(name: string, args: ExpressRouteCircuitPeeringArgs, opts?: CustomResourceOptions);

def ExpressRouteCircuitPeering(resource_name, opts=None, express_route_circuit_name=None, microsoft_peering_config=None, peer_asn=None, peering_type=None, primary_peer_address_prefix=None, resource_group_name=None, secondary_peer_address_prefix=None, shared_key=None, vlan_id=None, __props__=None);

func NewExpressRouteCircuitPeering(ctx *Context, name string, args ExpressRouteCircuitPeeringArgs, opts ...ResourceOption) (*ExpressRouteCircuitPeering, error)

public ExpressRouteCircuitPeering(string name, ExpressRouteCircuitPeeringArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

ExpressRouteCircuitPeering Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 /30 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 /30 subnet for the secondary link.
VlanId int: A valid VLAN ID to establish this peering on.
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..
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 /30 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 /30 subnet for the secondary link.
VlanId int: A valid VLAN ID to establish this peering on.
MicrosoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig: A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
PeerAsn int: The Either a 16-bit or a 32-bit ASN. Can either be public or private..
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 /30 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 /30 subnet for the secondary link.
vlanId number: A valid VLAN ID to establish this peering on.
microsoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig: A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
peerAsn number: The Either a 16-bit or a 32-bit ASN. Can either be public or private..
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 /30 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 /30 subnet for the secondary link.
vlan_id float: A valid VLAN ID to establish this peering on.
microsoft_peering_config Dict[ExpressRouteCircuitPeeringMicrosoftPeeringConfig]: A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
peer_asn float: The Either a 16-bit or a 32-bit ASN. Can either be public or private..
shared_key str: 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 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 float: 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.

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

static get(resource_name, id, opts=None, azure_asn=None, express_route_circuit_name=None, microsoft_peering_config=None, peer_asn=None, peering_type=None, primary_azure_port=None, primary_peer_address_prefix=None, resource_group_name=None, secondary_azure_port=None, secondary_peer_address_prefix=None, shared_key=None, vlan_id=None, __props__=None);

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)

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.

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.
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 /30 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.
SecondaryAzurePort string: The Secondary Port used by Azure for this Peering.
SecondaryPeerAddressPrefix string: A /30 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.
MicrosoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig: A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
PeerAsn int: The Either a 16-bit or a 32-bit ASN. Can either be public or private..
PeeringType string: The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
PrimaryAzurePort string: The Primary Port used by Azure for this Peering.
PrimaryPeerAddressPrefix string: A /30 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.
SecondaryAzurePort string: The Secondary Port used by Azure for this Peering.
SecondaryPeerAddressPrefix string: A /30 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 number: The ASN used by Azure.
expressRouteCircuitName string: The name of the ExpressRoute Circuit in which to create the Peering.
microsoftPeeringConfig ExpressRouteCircuitPeeringMicrosoftPeeringConfig: A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
peerAsn number: The Either a 16-bit or a 32-bit ASN. Can either be public or private..
peeringType string: The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
primaryAzurePort string: The Primary Port used by Azure for this Peering.
primaryPeerAddressPrefix string: A /30 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.
secondaryAzurePort string: The Secondary Port used by Azure for this Peering.
secondaryPeerAddressPrefix string: A /30 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 float: The ASN used by Azure.
express_route_circuit_name str: The name of the ExpressRoute Circuit in which to create the Peering.
microsoft_peering_config Dict[ExpressRouteCircuitPeeringMicrosoftPeeringConfig]: A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
peer_asn float: 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 /30 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_azure_port str: The Secondary Port used by Azure for this Peering.
secondary_peer_address_prefix str: A /30 subnet for the secondary link.
shared_key str: The shared key. Can be a maximum of 25 characters.
vlan_id float: A valid VLAN ID to establish this peering on.

Supporting Types

ExpressRouteCircuitPeeringMicrosoftPeeringConfig

See the input and output API doc for this type.

AdvertisedPublicPrefixes List<string>: A list of Advertised Public Prefixes
CustomerAsn int: The CustomerASN of the peering
RoutingRegistryName string: The RoutingRegistryName of the configuration

AdvertisedPublicPrefixes []string: A list of Advertised Public Prefixes
CustomerAsn int: The CustomerASN of the peering
RoutingRegistryName string: The RoutingRegistryName of the configuration

advertisedPublicPrefixes string[]: A list of Advertised Public Prefixes
customerAsn number: The CustomerASN of the peering
routingRegistryName string: The RoutingRegistryName of the configuration

advertisedPublicPrefixes List[str]: A list of Advertised Public Prefixes
customerAsn float: The CustomerASN of the peering
routingRegistryName str: The RoutingRegistryName of the configuration

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud