Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getExpressRouteCrossConnectionPeering
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getExpressRouteCrossConnectionPeering

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified peering for the ExpressRouteCrossConnection. Azure REST API version: 2023-02-01.

Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getExpressRouteCrossConnectionPeering

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getExpressRouteCrossConnectionPeering(args: GetExpressRouteCrossConnectionPeeringArgs, opts?: InvokeOptions): Promise<GetExpressRouteCrossConnectionPeeringResult>
function getExpressRouteCrossConnectionPeeringOutput(args: GetExpressRouteCrossConnectionPeeringOutputArgs, opts?: InvokeOptions): Output<GetExpressRouteCrossConnectionPeeringResult>
Copy
def get_express_route_cross_connection_peering(cross_connection_name: Optional[str] = None,
                                               peering_name: Optional[str] = None,
                                               resource_group_name: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetExpressRouteCrossConnectionPeeringResult
def get_express_route_cross_connection_peering_output(cross_connection_name: Optional[pulumi.Input[str]] = None,
                                               peering_name: Optional[pulumi.Input[str]] = None,
                                               resource_group_name: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetExpressRouteCrossConnectionPeeringResult]
Copy
func LookupExpressRouteCrossConnectionPeering(ctx *Context, args *LookupExpressRouteCrossConnectionPeeringArgs, opts ...InvokeOption) (*LookupExpressRouteCrossConnectionPeeringResult, error)
func LookupExpressRouteCrossConnectionPeeringOutput(ctx *Context, args *LookupExpressRouteCrossConnectionPeeringOutputArgs, opts ...InvokeOption) LookupExpressRouteCrossConnectionPeeringResultOutput
Copy

> Note: This function is named LookupExpressRouteCrossConnectionPeering in the Go SDK.

public static class GetExpressRouteCrossConnectionPeering 
{
    public static Task<GetExpressRouteCrossConnectionPeeringResult> InvokeAsync(GetExpressRouteCrossConnectionPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetExpressRouteCrossConnectionPeeringResult> Invoke(GetExpressRouteCrossConnectionPeeringInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExpressRouteCrossConnectionPeeringResult> getExpressRouteCrossConnectionPeering(GetExpressRouteCrossConnectionPeeringArgs args, InvokeOptions options)
public static Output<GetExpressRouteCrossConnectionPeeringResult> getExpressRouteCrossConnectionPeering(GetExpressRouteCrossConnectionPeeringArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getExpressRouteCrossConnectionPeering
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CrossConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRouteCrossConnection.
PeeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
CrossConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRouteCrossConnection.
PeeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
crossConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressRouteCrossConnection.
peeringName
This property is required.
Changes to this property will trigger replacement.
String
The name of the peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
crossConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRouteCrossConnection.
peeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
cross_connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ExpressRouteCrossConnection.
peering_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the peering.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
crossConnectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressRouteCrossConnection.
peeringName
This property is required.
Changes to this property will trigger replacement.
String
The name of the peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getExpressRouteCrossConnectionPeering Result

The following output properties are available:

AzureASN int
The Azure ASN.
Etag string
A unique read-only string that changes whenever the resource is updated.
LastModifiedBy string
Who was the last to modify the peering.
PrimaryAzurePort string
The primary port.
ProvisioningState string
The provisioning state of the express route cross connection peering resource.
SecondaryAzurePort string
The secondary port.
GatewayManagerEtag string
The GatewayManager Etag.
Id string
Resource ID.
Ipv6PeeringConfig Pulumi.AzureNative.Network.Outputs.Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
MicrosoftPeeringConfig Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerASN double
The peer ASN.
PeeringType string
The peering type.
PrimaryPeerAddressPrefix string
The primary address prefix.
SecondaryPeerAddressPrefix string
The secondary address prefix.
SharedKey string
The shared key.
State string
The peering state.
VlanId int
The VLAN ID.
AzureASN int
The Azure ASN.
Etag string
A unique read-only string that changes whenever the resource is updated.
LastModifiedBy string
Who was the last to modify the peering.
PrimaryAzurePort string
The primary port.
ProvisioningState string
The provisioning state of the express route cross connection peering resource.
SecondaryAzurePort string
The secondary port.
GatewayManagerEtag string
The GatewayManager Etag.
Id string
Resource ID.
Ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
MicrosoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerASN float64
The peer ASN.
PeeringType string
The peering type.
PrimaryPeerAddressPrefix string
The primary address prefix.
SecondaryPeerAddressPrefix string
The secondary address prefix.
SharedKey string
The shared key.
State string
The peering state.
VlanId int
The VLAN ID.
azureASN Integer
The Azure ASN.
etag String
A unique read-only string that changes whenever the resource is updated.
lastModifiedBy String
Who was the last to modify the peering.
primaryAzurePort String
The primary port.
provisioningState String
The provisioning state of the express route cross connection peering resource.
secondaryAzurePort String
The secondary port.
gatewayManagerEtag String
The GatewayManager Etag.
id String
Resource ID.
ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerASN Double
The peer ASN.
peeringType String
The peering type.
primaryPeerAddressPrefix String
The primary address prefix.
secondaryPeerAddressPrefix String
The secondary address prefix.
sharedKey String
The shared key.
state String
The peering state.
vlanId Integer
The VLAN ID.
azureASN number
The Azure ASN.
etag string
A unique read-only string that changes whenever the resource is updated.
lastModifiedBy string
Who was the last to modify the peering.
primaryAzurePort string
The primary port.
provisioningState string
The provisioning state of the express route cross connection peering resource.
secondaryAzurePort string
The secondary port.
gatewayManagerEtag string
The GatewayManager Etag.
id string
Resource ID.
ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerASN number
The peer ASN.
peeringType string
The peering type.
primaryPeerAddressPrefix string
The primary address prefix.
secondaryPeerAddressPrefix string
The secondary address prefix.
sharedKey string
The shared key.
state string
The peering state.
vlanId number
The VLAN ID.
azure_asn int
The Azure ASN.
etag str
A unique read-only string that changes whenever the resource is updated.
last_modified_by str
Who was the last to modify the peering.
primary_azure_port str
The primary port.
provisioning_state str
The provisioning state of the express route cross connection peering resource.
secondary_azure_port str
The secondary port.
gateway_manager_etag str
The GatewayManager Etag.
id str
Resource ID.
ipv6_peering_config Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
microsoft_peering_config ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peer_asn float
The peer ASN.
peering_type str
The peering type.
primary_peer_address_prefix str
The primary address prefix.
secondary_peer_address_prefix str
The secondary address prefix.
shared_key str
The shared key.
state str
The peering state.
vlan_id int
The VLAN ID.
azureASN Number
The Azure ASN.
etag String
A unique read-only string that changes whenever the resource is updated.
lastModifiedBy String
Who was the last to modify the peering.
primaryAzurePort String
The primary port.
provisioningState String
The provisioning state of the express route cross connection peering resource.
secondaryAzurePort String
The secondary port.
gatewayManagerEtag String
The GatewayManager Etag.
id String
Resource ID.
ipv6PeeringConfig Property Map
The IPv6 peering configuration.
microsoftPeeringConfig Property Map
The Microsoft peering configuration.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerASN Number
The peer ASN.
peeringType String
The peering type.
primaryPeerAddressPrefix String
The primary address prefix.
secondaryPeerAddressPrefix String
The secondary address prefix.
sharedKey String
The shared key.
state String
The peering state.
vlanId Number
The VLAN ID.

Supporting Types

ExpressRouteCircuitPeeringConfigResponse

AdvertisedPublicPrefixesState This property is required. string
The advertised public prefix state of the Peering resource.
AdvertisedCommunities List<string>
The communities of bgp peering. Specified for microsoft peering.
AdvertisedPublicPrefixes List<string>
The reference to AdvertisedPublicPrefixes.
CustomerASN int
The CustomerASN of the peering.
LegacyMode int
The legacy mode of the peering.
RoutingRegistryName string
The RoutingRegistryName of the configuration.
AdvertisedPublicPrefixesState This property is required. string
The advertised public prefix state of the Peering resource.
AdvertisedCommunities []string
The communities of bgp peering. Specified for microsoft peering.
AdvertisedPublicPrefixes []string
The reference to AdvertisedPublicPrefixes.
CustomerASN int
The CustomerASN of the peering.
LegacyMode int
The legacy mode of the peering.
RoutingRegistryName string
The RoutingRegistryName of the configuration.
advertisedPublicPrefixesState This property is required. String
The advertised public prefix state of the Peering resource.
advertisedCommunities List<String>
The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes List<String>
The reference to AdvertisedPublicPrefixes.
customerASN Integer
The CustomerASN of the peering.
legacyMode Integer
The legacy mode of the peering.
routingRegistryName String
The RoutingRegistryName of the configuration.
advertisedPublicPrefixesState This property is required. string
The advertised public prefix state of the Peering resource.
advertisedCommunities string[]
The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes string[]
The reference to AdvertisedPublicPrefixes.
customerASN number
The CustomerASN of the peering.
legacyMode number
The legacy mode of the peering.
routingRegistryName string
The RoutingRegistryName of the configuration.
advertised_public_prefixes_state This property is required. str
The advertised public prefix state of the Peering resource.
advertised_communities Sequence[str]
The communities of bgp peering. Specified for microsoft peering.
advertised_public_prefixes Sequence[str]
The reference to AdvertisedPublicPrefixes.
customer_asn int
The CustomerASN of the peering.
legacy_mode int
The legacy mode of the peering.
routing_registry_name str
The RoutingRegistryName of the configuration.
advertisedPublicPrefixesState This property is required. String
The advertised public prefix state of the Peering resource.
advertisedCommunities List<String>
The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes List<String>
The reference to AdvertisedPublicPrefixes.
customerASN Number
The CustomerASN of the peering.
legacyMode Number
The legacy mode of the peering.
routingRegistryName String
The RoutingRegistryName of the configuration.

Ipv6ExpressRouteCircuitPeeringConfigResponse

MicrosoftPeeringConfig Pulumi.AzureNative.Network.Inputs.ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
PrimaryPeerAddressPrefix string
The primary address prefix.
RouteFilter Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The reference to the RouteFilter resource.
SecondaryPeerAddressPrefix string
The secondary address prefix.
State string
The state of peering.
MicrosoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
PrimaryPeerAddressPrefix string
The primary address prefix.
RouteFilter SubResourceResponse
The reference to the RouteFilter resource.
SecondaryPeerAddressPrefix string
The secondary address prefix.
State string
The state of peering.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
primaryPeerAddressPrefix String
The primary address prefix.
routeFilter SubResourceResponse
The reference to the RouteFilter resource.
secondaryPeerAddressPrefix String
The secondary address prefix.
state String
The state of peering.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
primaryPeerAddressPrefix string
The primary address prefix.
routeFilter SubResourceResponse
The reference to the RouteFilter resource.
secondaryPeerAddressPrefix string
The secondary address prefix.
state string
The state of peering.
microsoft_peering_config ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
primary_peer_address_prefix str
The primary address prefix.
route_filter SubResourceResponse
The reference to the RouteFilter resource.
secondary_peer_address_prefix str
The secondary address prefix.
state str
The state of peering.
microsoftPeeringConfig Property Map
The Microsoft peering configuration.
primaryPeerAddressPrefix String
The primary address prefix.
routeFilter Property Map
The reference to the RouteFilter resource.
secondaryPeerAddressPrefix String
The secondary address prefix.
state String
The state of peering.

SubResourceResponse

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native