GetExpressRouteCircuit

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Network.GetExpressRouteCircuit.InvokeAsync(new Azure.Network.GetExpressRouteCircuitArgs
        {
            ResourceGroupName = azurerm_resource_group.Example.Name,
            Name = azurerm_express_route_circuit.Example.Name,
        }));
        this.ExpressRouteCircuitId = example.Apply(example => example.Id);
        this.ServiceKey = example.Apply(example => example.ServiceKey);
    }

    [Output("expressRouteCircuitId")]
    public Output<string> ExpressRouteCircuitId { get; set; }
    [Output("serviceKey")]
    public Output<string> ServiceKey { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/network"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := network.LookupExpressRouteCircuit(ctx, &network.LookupExpressRouteCircuitArgs{
            ResourceGroupName: azurerm_resource_group.Example.Name,
            Name:              azurerm_express_route_circuit.Example.Name,
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("expressRouteCircuitId", example.Id)
        ctx.Export("serviceKey", example.ServiceKey)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.network.get_express_route_circuit(resource_group_name=azurerm_resource_group["example"]["name"],
    name=azurerm_express_route_circuit["example"]["name"])
pulumi.export("expressRouteCircuitId", example.id)
pulumi.export("serviceKey", example.service_key)

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

const example = azure.network.getExpressRouteCircuit({
    resourceGroupName: azurerm_resource_group.example.name,
    name: azurerm_express_route_circuit.example.name,
});
export const expressRouteCircuitId = example.then(example => example.id);
export const serviceKey = example.then(example => example.serviceKey);

Using GetExpressRouteCircuit

function getExpressRouteCircuit(args: GetExpressRouteCircuitArgs, opts?: InvokeOptions): Promise<GetExpressRouteCircuitResult>

function  get_express_route_circuit(name=None, resource_group_name=None, opts=None)

func LookupExpressRouteCircuit(ctx *Context, args *LookupExpressRouteCircuitArgs, opts ...InvokeOption) (*LookupExpressRouteCircuitResult, error)

Note: This function is named LookupExpressRouteCircuit in the Go SDK.

public static class GetExpressRouteCircuit {
    public static Task<GetExpressRouteCircuitResult> InvokeAsync(GetExpressRouteCircuitArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the ExpressRoute circuit.
ResourceGroupName string: The Name of the Resource Group where the ExpressRoute circuit exists.

Name string: The name of the ExpressRoute circuit.
ResourceGroupName string: The Name of the Resource Group where the ExpressRoute circuit exists.

name string: The name of the ExpressRoute circuit.
resourceGroupName string: The Name of the Resource Group where the ExpressRoute circuit exists.

name str: The name of the ExpressRoute circuit.
resource_group_name str: The Name of the Resource Group where the ExpressRoute circuit exists.

GetExpressRouteCircuit Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure location where the ExpressRoute circuit exists
Name string
Peerings List<GetExpressRouteCircuitPeering>: A peerings block for the ExpressRoute circuit as documented below
ResourceGroupName string
ServiceKey string: The string needed by the service provider to provision the ExpressRoute circuit.
ServiceProviderProperties List<GetExpressRouteCircuitServiceProviderProperty>: A service_provider_properties block for the ExpressRoute circuit as documented below
ServiceProviderProvisioningState string: The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.
Sku GetExpressRouteCircuitSku: A sku block for the ExpressRoute circuit as documented below.

Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure location where the ExpressRoute circuit exists
Name string
Peerings []GetExpressRouteCircuitPeeringType: A peerings block for the ExpressRoute circuit as documented below
ResourceGroupName string
ServiceKey string: The string needed by the service provider to provision the ExpressRoute circuit.
ServiceProviderProperties []GetExpressRouteCircuitServiceProviderProperty: A service_provider_properties block for the ExpressRoute circuit as documented below
ServiceProviderProvisioningState string: The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.
Sku GetExpressRouteCircuitSku: A sku block for the ExpressRoute circuit as documented below.

id string: The provider-assigned unique ID for this managed resource.
location string: The Azure location where the ExpressRoute circuit exists
name string
peerings GetExpressRouteCircuitPeering[]: A peerings block for the ExpressRoute circuit as documented below
resourceGroupName string
serviceKey string: The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderProperties GetExpressRouteCircuitServiceProviderProperty[]: A service_provider_properties block for the ExpressRoute circuit as documented below
serviceProviderProvisioningState string: The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.
sku GetExpressRouteCircuitSku: A sku block for the ExpressRoute circuit as documented below.

id str: The provider-assigned unique ID for this managed resource.
location str: The Azure location where the ExpressRoute circuit exists
name str
peerings List[GetExpressRouteCircuitPeering]: A peerings block for the ExpressRoute circuit as documented below
resource_group_name str
service_key str: The string needed by the service provider to provision the ExpressRoute circuit.
service_provider_properties List[GetExpressRouteCircuitServiceProviderProperty]: A service_provider_properties block for the ExpressRoute circuit as documented below
service_provider_provisioning_state str: The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.
sku Dict[GetExpressRouteCircuitSku]: A sku block for the ExpressRoute circuit as documented below.

Supporting Types

GetExpressRouteCircuitPeering

See the output API doc for this type.

AzureAsn int: The Either a 16-bit or a 32-bit ASN for Azure.
PeerAsn int: The Either a 16-bit or a 32-bit ASN. Can either be public or private.
PeeringType string: The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
PrimaryPeerAddressPrefix string: A /30 subnet for the primary link.
SecondaryPeerAddressPrefix string: A /30 subnet for the secondary link.
SharedKey string: The shared key. Can be a maximum of 25 characters.
VlanId int: A valid VLAN ID to establish this peering on.

AzureAsn int: The Either a 16-bit or a 32-bit ASN for Azure.
PeerAsn int: The Either a 16-bit or a 32-bit ASN. Can either be public or private.
PeeringType string: The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
PrimaryPeerAddressPrefix string: A /30 subnet for the primary link.
SecondaryPeerAddressPrefix string: A /30 subnet for the secondary link.
SharedKey string: The shared key. Can be a maximum of 25 characters.
VlanId int: A valid VLAN ID to establish this peering on.

azureAsn number: The Either a 16-bit or a 32-bit ASN for Azure.
peerAsn number: The Either a 16-bit or a 32-bit ASN. Can either be public or private.
peeringType string: The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
primaryPeerAddressPrefix string: A /30 subnet for the primary link.
secondaryPeerAddressPrefix string: A /30 subnet for the secondary link.
sharedKey string: The shared key. Can be a maximum of 25 characters.
vlanId number: A valid VLAN ID to establish this peering on.

azure_asn float: The Either a 16-bit or a 32-bit ASN for Azure.
peer_asn float: The Either a 16-bit or a 32-bit ASN. Can either be public or private.
peering_type str: The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
primary_peer_address_prefix str: A /30 subnet for the primary link.
secondary_peer_address_prefix str: A /30 subnet for the secondary link.
shared_key str: The shared key. Can be a maximum of 25 characters.
vlan_id float: A valid VLAN ID to establish this peering on.

GetExpressRouteCircuitServiceProviderProperty

See the output API doc for this type.

BandwidthInMbps int: The bandwidth in Mbps of the ExpressRoute circuit.
PeeringLocation string: The name of the peering location and not the Azure resource location.
ServiceProviderName string: The name of the ExpressRoute Service Provider.

BandwidthInMbps int: The bandwidth in Mbps of the ExpressRoute circuit.
PeeringLocation string: The name of the peering location and not the Azure resource location.
ServiceProviderName string: The name of the ExpressRoute Service Provider.

bandwidthInMbps number: The bandwidth in Mbps of the ExpressRoute circuit.
peeringLocation string: The name of the peering location and not the Azure resource location.
serviceProviderName string: The name of the ExpressRoute Service Provider.

bandwidth_in_mbps float: The bandwidth in Mbps of the ExpressRoute circuit.
peering_location str: The name of the peering location and not the Azure resource location.
service_provider_name str: The name of the ExpressRoute Service Provider.

GetExpressRouteCircuitSku

See the output API doc for this type.

Family string: The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
Tier string: The service tier. Possible values are Basic, Local, Standard or Premium.

Family string: The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
Tier string: The service tier. Possible values are Basic, Local, Standard or Premium.

family string: The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
tier string: The service tier. Possible values are Basic, Local, Standard or Premium.

family str: The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
tier str: The service tier. Possible values are Basic, Local, Standard or Premium.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetExpressRouteCircuit

Example Usage

Using GetExpressRouteCircuit

GetExpressRouteCircuit Result

Supporting Types

GetExpressRouteCircuitPeering

GetExpressRouteCircuitServiceProviderProperty

GetExpressRouteCircuitSku

Package Details

On This Page