Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. expressroute
  5. getCircuitPeering

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.expressroute.getCircuitPeering

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Use this data source to access information about an existing ExpressRoute Circuit Peering.

Example Usage

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

const example = azure.expressroute.getCircuitPeering({
    peeringType: "example-peering",
    expressRouteCircuitName: "example-expressroute",
    resourceGroupName: "example-resources",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.expressroute.get_circuit_peering(peering_type="example-peering",
    express_route_circuit_name="example-expressroute",
    resource_group_name="example-resources")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/expressroute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := expressroute.GetCircuitPeering(ctx, &expressroute.GetCircuitPeeringArgs{
			PeeringType:             "example-peering",
			ExpressRouteCircuitName: "example-expressroute",
			ResourceGroupName:       "example-resources",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.ExpressRoute.GetCircuitPeering.Invoke(new()
    {
        PeeringType = "example-peering",
        ExpressRouteCircuitName = "example-expressroute",
        ResourceGroupName = "example-resources",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.expressroute.ExpressrouteFunctions;
import com.pulumi.azure.expressroute.inputs.GetCircuitPeeringArgs;
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) {
        final var example = ExpressrouteFunctions.getCircuitPeering(GetCircuitPeeringArgs.builder()
            .peeringType("example-peering")
            .expressRouteCircuitName("example-expressroute")
            .resourceGroupName("example-resources")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:expressroute:getCircuitPeering
      arguments:
        peeringType: example-peering
        expressRouteCircuitName: example-expressroute
        resourceGroupName: example-resources
Copy

Using getCircuitPeering

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 getCircuitPeering(args: GetCircuitPeeringArgs, opts?: InvokeOptions): Promise<GetCircuitPeeringResult>
function getCircuitPeeringOutput(args: GetCircuitPeeringOutputArgs, opts?: InvokeOptions): Output<GetCircuitPeeringResult>
Copy
def get_circuit_peering(express_route_circuit_name: Optional[str] = None,
                        peering_type: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCircuitPeeringResult
def get_circuit_peering_output(express_route_circuit_name: Optional[pulumi.Input[str]] = None,
                        peering_type: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetCircuitPeeringResult]
Copy
func GetCircuitPeering(ctx *Context, args *GetCircuitPeeringArgs, opts ...InvokeOption) (*GetCircuitPeeringResult, error)
func GetCircuitPeeringOutput(ctx *Context, args *GetCircuitPeeringOutputArgs, opts ...InvokeOption) GetCircuitPeeringResultOutput
Copy

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

public static class GetCircuitPeering 
{
    public static Task<GetCircuitPeeringResult> InvokeAsync(GetCircuitPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetCircuitPeeringResult> Invoke(GetCircuitPeeringInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCircuitPeeringResult> getCircuitPeering(GetCircuitPeeringArgs args, InvokeOptions options)
public static Output<GetCircuitPeeringResult> getCircuitPeering(GetCircuitPeeringArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:expressroute/getCircuitPeering:getCircuitPeering
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExpressRouteCircuitName This property is required. string
The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.
PeeringType This property is required. string
The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.
ResourceGroupName This property is required. 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.
ExpressRouteCircuitName This property is required. string
The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.
PeeringType This property is required. string
The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.
ResourceGroupName This property is required. 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.
expressRouteCircuitName This property is required. String
The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.
peeringType This property is required. String
The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.
resourceGroupName This property is required. 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.
expressRouteCircuitName This property is required. string
The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.
peeringType This property is required. string
The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.
resourceGroupName This property is required. 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.
express_route_circuit_name This property is required. str
The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.
peering_type This property is required. str
The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.
resource_group_name This property is required. 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.
expressRouteCircuitName This property is required. String
The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.
peeringType This property is required. String
The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.
resourceGroupName This property is required. 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.

getCircuitPeering Result

The following output properties are available:

AzureAsn int
The ASN used by Azure for the peering.
ExpressRouteCircuitName string
GatewayManagerEtag string
Id string
The provider-assigned unique ID for this managed resource.
Ipv4Enabled bool
Indicates if IPv4 is enabled.
PeerAsn int
PeeringType string
The type of the ExpressRoute Circuit Peering.
PrimaryAzurePort string
The primary port used by Azure for this peering.
PrimaryPeerAddressPrefix string
The primary peer address prefix.
ResourceGroupName string
RouteFilterId string
SecondaryAzurePort string
The secondary port used by Azure for this peering.
SecondaryPeerAddressPrefix string
The secondary peer address prefix.
SharedKey string
VlanId int
The VLAN ID used for this peering.
AzureAsn int
The ASN used by Azure for the peering.
ExpressRouteCircuitName string
GatewayManagerEtag string
Id string
The provider-assigned unique ID for this managed resource.
Ipv4Enabled bool
Indicates if IPv4 is enabled.
PeerAsn int
PeeringType string
The type of the ExpressRoute Circuit Peering.
PrimaryAzurePort string
The primary port used by Azure for this peering.
PrimaryPeerAddressPrefix string
The primary peer address prefix.
ResourceGroupName string
RouteFilterId string
SecondaryAzurePort string
The secondary port used by Azure for this peering.
SecondaryPeerAddressPrefix string
The secondary peer address prefix.
SharedKey string
VlanId int
The VLAN ID used for this peering.
azureAsn Integer
The ASN used by Azure for the peering.
expressRouteCircuitName String
gatewayManagerEtag String
id String
The provider-assigned unique ID for this managed resource.
ipv4Enabled Boolean
Indicates if IPv4 is enabled.
peerAsn Integer
peeringType String
The type of the ExpressRoute Circuit Peering.
primaryAzurePort String
The primary port used by Azure for this peering.
primaryPeerAddressPrefix String
The primary peer address prefix.
resourceGroupName String
routeFilterId String
secondaryAzurePort String
The secondary port used by Azure for this peering.
secondaryPeerAddressPrefix String
The secondary peer address prefix.
sharedKey String
vlanId Integer
The VLAN ID used for this peering.
azureAsn number
The ASN used by Azure for the peering.
expressRouteCircuitName string
gatewayManagerEtag string
id string
The provider-assigned unique ID for this managed resource.
ipv4Enabled boolean
Indicates if IPv4 is enabled.
peerAsn number
peeringType string
The type of the ExpressRoute Circuit Peering.
primaryAzurePort string
The primary port used by Azure for this peering.
primaryPeerAddressPrefix string
The primary peer address prefix.
resourceGroupName string
routeFilterId string
secondaryAzurePort string
The secondary port used by Azure for this peering.
secondaryPeerAddressPrefix string
The secondary peer address prefix.
sharedKey string
vlanId number
The VLAN ID used for this peering.
azure_asn int
The ASN used by Azure for the peering.
express_route_circuit_name str
gateway_manager_etag str
id str
The provider-assigned unique ID for this managed resource.
ipv4_enabled bool
Indicates if IPv4 is enabled.
peer_asn int
peering_type str
The type of the ExpressRoute Circuit Peering.
primary_azure_port str
The primary port used by Azure for this peering.
primary_peer_address_prefix str
The primary peer address prefix.
resource_group_name str
route_filter_id str
secondary_azure_port str
The secondary port used by Azure for this peering.
secondary_peer_address_prefix str
The secondary peer address prefix.
shared_key str
vlan_id int
The VLAN ID used for this peering.
azureAsn Number
The ASN used by Azure for the peering.
expressRouteCircuitName String
gatewayManagerEtag String
id String
The provider-assigned unique ID for this managed resource.
ipv4Enabled Boolean
Indicates if IPv4 is enabled.
peerAsn Number
peeringType String
The type of the ExpressRoute Circuit Peering.
primaryAzurePort String
The primary port used by Azure for this peering.
primaryPeerAddressPrefix String
The primary peer address prefix.
resourceGroupName String
routeFilterId String
secondaryAzurePort String
The secondary port used by Azure for this peering.
secondaryPeerAddressPrefix String
The secondary peer address prefix.
sharedKey String
vlanId Number
The VLAN ID used for this peering.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure