getCircuitPeering

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",
});
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")
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",
});
});
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
})
}
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());
}
}
variables:
example:
fn::invoke:
function: azure:expressroute:getCircuitPeering
arguments:
peeringType: example-peering
expressRouteCircuitName: example-expressroute
resourceGroupName: example-resources

API Providers

This data source uses the following Azure API Providers:

  • Microsoft.Network: 2024-05-01

Return

A collection of values returned by getCircuitPeering.

Parameters

argument

A collection of arguments for invoking getCircuitPeering.


suspend fun getCircuitPeering(expressRouteCircuitName: String, peeringType: String, resourceGroupName: String): GetCircuitPeeringResult

Return

A collection of values returned by getCircuitPeering.

Parameters

expressRouteCircuitName

The name of the ExpressRoute Circuit in which to create the Peering. Changing this forces a new resource to be created.

peeringType

The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering.

resourceGroupName

The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.

See also


Return

A collection of values returned by getCircuitPeering.

Parameters

argument

Builder for com.pulumi.azure.expressroute.kotlin.inputs.GetCircuitPeeringPlainArgs.

See also