azure-native.network.getExpressRouteCrossConnectionPeering
Explore with Pulumi AI
Gets the specified peering for the ExpressRouteCrossConnection.
Uses Azure REST API version 2024-05-01.
Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.
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>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]func LookupExpressRouteCrossConnectionPeering(ctx *Context, args *LookupExpressRouteCrossConnectionPeeringArgs, opts ...InvokeOption) (*LookupExpressRouteCrossConnectionPeeringResult, error)
func LookupExpressRouteCrossConnectionPeeringOutput(ctx *Context, args *LookupExpressRouteCrossConnectionPeeringOutputArgs, opts ...InvokeOption) LookupExpressRouteCrossConnectionPeeringResultOutput> 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)
}public static CompletableFuture<GetExpressRouteCrossConnectionPeeringResult> getExpressRouteCrossConnectionPeering(GetExpressRouteCrossConnectionPeeringArgs args, InvokeOptions options)
public static Output<GetExpressRouteCrossConnectionPeeringResult> getExpressRouteCrossConnectionPeering(GetExpressRouteCrossConnectionPeeringArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:network:getExpressRouteCrossConnectionPeering
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Cross
Connection stringName  - The name of the ExpressRouteCrossConnection.
 - Peering
Name string - The name of the peering.
 - Resource
Group stringName  - The name of the resource group.
 
- Cross
Connection stringName  - The name of the ExpressRouteCrossConnection.
 - Peering
Name string - The name of the peering.
 - Resource
Group stringName  - The name of the resource group.
 
- cross
Connection StringName  - The name of the ExpressRouteCrossConnection.
 - peering
Name String - The name of the peering.
 - resource
Group StringName  - The name of the resource group.
 
- cross
Connection stringName  - The name of the ExpressRouteCrossConnection.
 - peering
Name string - The name of the peering.
 - resource
Group stringName  - The name of the resource group.
 
- cross_
connection_ strname  - The name of the ExpressRouteCrossConnection.
 - peering_
name str - The name of the peering.
 - resource_
group_ strname  - The name of the resource group.
 
- cross
Connection StringName  - The name of the ExpressRouteCrossConnection.
 - peering
Name String - The name of the peering.
 - resource
Group StringName  - The name of the resource group.
 
getExpressRouteCrossConnectionPeering Result
The following output properties are available:
- Azure
ASN int - The Azure ASN.
 - Azure
Api stringVersion  - The Azure API version of the resource.
 - Etag string
 - A unique read-only string that changes whenever the resource is updated.
 - Last
Modified stringBy  - Who was the last to modify the peering.
 - Primary
Azure stringPort  - The primary port.
 - Provisioning
State string - The provisioning state of the express route cross connection peering resource.
 - Secondary
Azure stringPort  - The secondary port.
 - Gateway
Manager stringEtag  - The GatewayManager Etag.
 - Id string
 - Resource ID.
 - Ipv6Peering
Config Pulumi.Azure Native. Network. Outputs. Ipv6Express Route Circuit Peering Config Response  - The IPv6 peering configuration.
 - Microsoft
Peering Pulumi.Config Azure Native. Network. Outputs. Express Route Circuit Peering Config Response  - 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.
 - Peer
ASN double - The peer ASN.
 - Peering
Type string - The peering type.
 - Primary
Peer stringAddress Prefix  - The primary address prefix.
 - Secondary
Peer stringAddress Prefix  - The secondary address prefix.
 - string
 - The shared key.
 - State string
 - The peering state.
 - Vlan
Id int - The VLAN ID.
 
- Azure
ASN int - The Azure ASN.
 - Azure
Api stringVersion  - The Azure API version of the resource.
 - Etag string
 - A unique read-only string that changes whenever the resource is updated.
 - Last
Modified stringBy  - Who was the last to modify the peering.
 - Primary
Azure stringPort  - The primary port.
 - Provisioning
State string - The provisioning state of the express route cross connection peering resource.
 - Secondary
Azure stringPort  - The secondary port.
 - Gateway
Manager stringEtag  - The GatewayManager Etag.
 - Id string
 - Resource ID.
 - Ipv6Peering
Config Ipv6ExpressRoute Circuit Peering Config Response  - The IPv6 peering configuration.
 - Microsoft
Peering ExpressConfig Route Circuit Peering Config Response  - 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.
 - Peer
ASN float64 - The peer ASN.
 - Peering
Type string - The peering type.
 - Primary
Peer stringAddress Prefix  - The primary address prefix.
 - Secondary
Peer stringAddress Prefix  - The secondary address prefix.
 - string
 - The shared key.
 - State string
 - The peering state.
 - Vlan
Id int - The VLAN ID.
 
- azure
ASN Integer - The Azure ASN.
 - azure
Api StringVersion  - The Azure API version of the resource.
 - etag String
 - A unique read-only string that changes whenever the resource is updated.
 - last
Modified StringBy  - Who was the last to modify the peering.
 - primary
Azure StringPort  - The primary port.
 - provisioning
State String - The provisioning state of the express route cross connection peering resource.
 - secondary
Azure StringPort  - The secondary port.
 - gateway
Manager StringEtag  - The GatewayManager Etag.
 - id String
 - Resource ID.
 - ipv6Peering
Config Ipv6ExpressRoute Circuit Peering Config Response  - The IPv6 peering configuration.
 - microsoft
Peering ExpressConfig Route Circuit Peering Config Response  - 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.
 - peer
ASN Double - The peer ASN.
 - peering
Type String - The peering type.
 - primary
Peer StringAddress Prefix  - The primary address prefix.
 - secondary
Peer StringAddress Prefix  - The secondary address prefix.
 - String
 - The shared key.
 - state String
 - The peering state.
 - vlan
Id Integer - The VLAN ID.
 
- azure
ASN number - The Azure ASN.
 - azure
Api stringVersion  - The Azure API version of the resource.
 - etag string
 - A unique read-only string that changes whenever the resource is updated.
 - last
Modified stringBy  - Who was the last to modify the peering.
 - primary
Azure stringPort  - The primary port.
 - provisioning
State string - The provisioning state of the express route cross connection peering resource.
 - secondary
Azure stringPort  - The secondary port.
 - gateway
Manager stringEtag  - The GatewayManager Etag.
 - id string
 - Resource ID.
 - ipv6Peering
Config Ipv6ExpressRoute Circuit Peering Config Response  - The IPv6 peering configuration.
 - microsoft
Peering ExpressConfig Route Circuit Peering Config Response  - 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.
 - peer
ASN number - The peer ASN.
 - peering
Type string - The peering type.
 - primary
Peer stringAddress Prefix  - The primary address prefix.
 - secondary
Peer stringAddress Prefix  - The secondary address prefix.
 - string
 - The shared key.
 - state string
 - The peering state.
 - vlan
Id number - The VLAN ID.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - azure_
asn int - The Azure ASN.
 - etag str
 - A unique read-only string that changes whenever the resource is updated.
 - last_
modified_ strby  - Who was the last to modify the peering.
 - primary_
azure_ strport  - The primary port.
 - provisioning_
state str - The provisioning state of the express route cross connection peering resource.
 - secondary_
azure_ strport  - The secondary port.
 - gateway_
manager_ stretag  - The GatewayManager Etag.
 - id str
 - Resource ID.
 - ipv6_
peering_ Ipv6Expressconfig Route Circuit Peering Config Response  - The IPv6 peering configuration.
 - microsoft_
peering_ Expressconfig Route Circuit Peering Config Response  - 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_ straddress_ prefix  - The primary address prefix.
 - secondary_
peer_ straddress_ prefix  - The secondary address prefix.
 - str
 - The shared key.
 - state str
 - The peering state.
 - vlan_
id int - The VLAN ID.
 
- azure
ASN Number - The Azure ASN.
 - azure
Api StringVersion  - The Azure API version of the resource.
 - etag String
 - A unique read-only string that changes whenever the resource is updated.
 - last
Modified StringBy  - Who was the last to modify the peering.
 - primary
Azure StringPort  - The primary port.
 - provisioning
State String - The provisioning state of the express route cross connection peering resource.
 - secondary
Azure StringPort  - The secondary port.
 - gateway
Manager StringEtag  - The GatewayManager Etag.
 - id String
 - Resource ID.
 - ipv6Peering
Config Property Map - The IPv6 peering configuration.
 - microsoft
Peering Property MapConfig  - 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.
 - peer
ASN Number - The peer ASN.
 - peering
Type String - The peering type.
 - primary
Peer StringAddress Prefix  - The primary address prefix.
 - secondary
Peer StringAddress Prefix  - The secondary address prefix.
 - String
 - The shared key.
 - state String
 - The peering state.
 - vlan
Id Number - The VLAN ID.
 
Supporting Types
ExpressRouteCircuitPeeringConfigResponse     
- Advertised
Public stringPrefixes State  - The advertised public prefix state of the Peering resource.
 - Advertised
Communities List<string> - The communities of bgp peering. Specified for microsoft peering.
 - Advertised
Public List<string>Prefixes  - The reference to AdvertisedPublicPrefixes.
 - Customer
ASN int - The CustomerASN of the peering.
 - Legacy
Mode int - The legacy mode of the peering.
 - Routing
Registry stringName  - The RoutingRegistryName of the configuration.
 
- Advertised
Public stringPrefixes State  - The advertised public prefix state of the Peering resource.
 - Advertised
Communities []string - The communities of bgp peering. Specified for microsoft peering.
 - Advertised
Public []stringPrefixes  - The reference to AdvertisedPublicPrefixes.
 - Customer
ASN int - The CustomerASN of the peering.
 - Legacy
Mode int - The legacy mode of the peering.
 - Routing
Registry stringName  - The RoutingRegistryName of the configuration.
 
- advertised
Public StringPrefixes State  - The advertised public prefix state of the Peering resource.
 - advertised
Communities List<String> - The communities of bgp peering. Specified for microsoft peering.
 - advertised
Public List<String>Prefixes  - The reference to AdvertisedPublicPrefixes.
 - customer
ASN Integer - The CustomerASN of the peering.
 - legacy
Mode Integer - The legacy mode of the peering.
 - routing
Registry StringName  - The RoutingRegistryName of the configuration.
 
- advertised
Public stringPrefixes State  - The advertised public prefix state of the Peering resource.
 - advertised
Communities string[] - The communities of bgp peering. Specified for microsoft peering.
 - advertised
Public string[]Prefixes  - The reference to AdvertisedPublicPrefixes.
 - customer
ASN number - The CustomerASN of the peering.
 - legacy
Mode number - The legacy mode of the peering.
 - routing
Registry stringName  - The RoutingRegistryName of the configuration.
 
- advertised_
public_ strprefixes_ state  - The advertised public prefix state of the Peering resource.
 - advertised_
communities Sequence[str] - The communities of bgp peering. Specified for microsoft peering.
 - advertised_
public_ Sequence[str]prefixes  - The reference to AdvertisedPublicPrefixes.
 - customer_
asn int - The CustomerASN of the peering.
 - legacy_
mode int - The legacy mode of the peering.
 - routing_
registry_ strname  - The RoutingRegistryName of the configuration.
 
- advertised
Public StringPrefixes State  - The advertised public prefix state of the Peering resource.
 - advertised
Communities List<String> - The communities of bgp peering. Specified for microsoft peering.
 - advertised
Public List<String>Prefixes  - The reference to AdvertisedPublicPrefixes.
 - customer
ASN Number - The CustomerASN of the peering.
 - legacy
Mode Number - The legacy mode of the peering.
 - routing
Registry StringName  - The RoutingRegistryName of the configuration.
 
Ipv6ExpressRouteCircuitPeeringConfigResponse     
- Microsoft
Peering Pulumi.Config Azure Native. Network. Inputs. Express Route Circuit Peering Config Response  - The Microsoft peering configuration.
 - Primary
Peer stringAddress Prefix  - The primary address prefix.
 - Route
Filter Pulumi.Azure Native. Network. Inputs. Sub Resource Response  - The reference to the RouteFilter resource.
 - Secondary
Peer stringAddress Prefix  - The secondary address prefix.
 - State string
 - The state of peering.
 
- Microsoft
Peering ExpressConfig Route Circuit Peering Config Response  - The Microsoft peering configuration.
 - Primary
Peer stringAddress Prefix  - The primary address prefix.
 - Route
Filter SubResource Response  - The reference to the RouteFilter resource.
 - Secondary
Peer stringAddress Prefix  - The secondary address prefix.
 - State string
 - The state of peering.
 
- microsoft
Peering ExpressConfig Route Circuit Peering Config Response  - The Microsoft peering configuration.
 - primary
Peer StringAddress Prefix  - The primary address prefix.
 - route
Filter SubResource Response  - The reference to the RouteFilter resource.
 - secondary
Peer StringAddress Prefix  - The secondary address prefix.
 - state String
 - The state of peering.
 
- microsoft
Peering ExpressConfig Route Circuit Peering Config Response  - The Microsoft peering configuration.
 - primary
Peer stringAddress Prefix  - The primary address prefix.
 - route
Filter SubResource Response  - The reference to the RouteFilter resource.
 - secondary
Peer stringAddress Prefix  - The secondary address prefix.
 - state string
 - The state of peering.
 
- microsoft_
peering_ Expressconfig Route Circuit Peering Config Response  - The Microsoft peering configuration.
 - primary_
peer_ straddress_ prefix  - The primary address prefix.
 - route_
filter SubResource Response  - The reference to the RouteFilter resource.
 - secondary_
peer_ straddress_ prefix  - The secondary address prefix.
 - state str
 - The state of peering.
 
- microsoft
Peering Property MapConfig  - The Microsoft peering configuration.
 - primary
Peer StringAddress Prefix  - The primary address prefix.
 - route
Filter Property Map - The reference to the RouteFilter resource.
 - secondary
Peer StringAddress Prefix  - The secondary address prefix.
 - state String
 - The state of peering.
 
SubResourceResponse  
- Id string
 - Resource ID.
 
- Id string
 - Resource ID.
 
- id String
 - Resource ID.
 
- id string
 - Resource ID.
 
- id str
 - Resource ID.
 
- id String
 - Resource ID.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0