getExpressRouteCircuit

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.network.getExpressRouteCircuit({
resourceGroupName: exampleAzurermResourceGroup.name,
name: exampleAzurermExpressRouteCircuit.name,
});
export const expressRouteCircuitId = example.then(example => example.id);
export const serviceKey = example.then(example => example.serviceKey);
import pulumi
import pulumi_azure as azure
example = azure.network.get_express_route_circuit(resource_group_name=example_azurerm_resource_group["name"],
name=example_azurerm_express_route_circuit["name"])
pulumi.export("expressRouteCircuitId", example.id)
pulumi.export("serviceKey", example.service_key)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Network.GetExpressRouteCircuit.Invoke(new()
{
ResourceGroupName = exampleAzurermResourceGroup.Name,
Name = exampleAzurermExpressRouteCircuit.Name,
});
return new Dictionary<string, object?>
{
["expressRouteCircuitId"] = example.Apply(getExpressRouteCircuitResult => getExpressRouteCircuitResult.Id),
["serviceKey"] = example.Apply(getExpressRouteCircuitResult => getExpressRouteCircuitResult.ServiceKey),
};
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := network.LookupExpressRouteCircuit(ctx, &network.LookupExpressRouteCircuitArgs{
ResourceGroupName: exampleAzurermResourceGroup.Name,
Name: exampleAzurermExpressRouteCircuit.Name,
}, nil)
if err != nil {
return err
}
ctx.Export("expressRouteCircuitId", example.Id)
ctx.Export("serviceKey", example.ServiceKey)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetExpressRouteCircuitArgs;
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 = NetworkFunctions.getExpressRouteCircuit(GetExpressRouteCircuitArgs.builder()
.resourceGroupName(exampleAzurermResourceGroup.name())
.name(exampleAzurermExpressRouteCircuit.name())
.build());
ctx.export("expressRouteCircuitId", example.id());
ctx.export("serviceKey", example.serviceKey());
}
}
variables:
example:
fn::invoke:
function: azure:network:getExpressRouteCircuit
arguments:
resourceGroupName: ${exampleAzurermResourceGroup.name}
name: ${exampleAzurermExpressRouteCircuit.name}
outputs:
expressRouteCircuitId: ${example.id}
serviceKey: ${example.serviceKey}

API Providers

This data source uses the following Azure API Providers:

  • Microsoft.Network: 2024-05-01

Return

A collection of values returned by getExpressRouteCircuit.

Parameters

argument

A collection of arguments for invoking getExpressRouteCircuit.


suspend fun getExpressRouteCircuit(name: String, resourceGroupName: String): GetExpressRouteCircuitResult

Return

A collection of values returned by getExpressRouteCircuit.

Parameters

name

The name of the ExpressRoute circuit.

resourceGroupName

The Name of the Resource Group where the ExpressRoute circuit exists.

See also


Return

A collection of values returned by getExpressRouteCircuit.

Parameters

argument

Builder for com.pulumi.azure.network.kotlin.inputs.GetExpressRouteCircuitPlainArgs.

See also