Skip to content

Data Source: azurermExpressRouteCircuit

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

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermExpressRouteCircuitExample =
  new azurerm.dataAzurermExpressRouteCircuit.DataAzurermExpressRouteCircuit(
    this,
    "example",
    {
      name: "${azurerm_express_route_circuit.example.name}",
      resource_group_name: "${azurerm_resource_group.example.name}",
    }
  );
new cdktf.TerraformOutput(this, "express_route_circuit_id", {
  value: dataAzurermExpressRouteCircuitExample.id,
});
new cdktf.TerraformOutput(this, "service_key", {
  value: dataAzurermExpressRouteCircuitExample.serviceKey,
});

Argument Reference

  • name - The name of the ExpressRoute circuit.
  • resourceGroupName - The Name of the Resource Group where the ExpressRoute circuit exists.

Attributes Reference

  • id - The ID of the ExpressRoute circuit.

  • location - The Azure location where the ExpressRoute circuit exists

  • peerings - A peerings block for the ExpressRoute circuit as documented below

  • serviceProviderProvisioningState - The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are notProvisioned, provisioning, provisioned, and deprovisioning.

  • serviceKey - The string needed by the service provider to provision the ExpressRoute circuit.

  • serviceProviderProperties - A serviceProviderProperties block for the ExpressRoute circuit as documented below

  • sku - A sku block for the ExpressRoute circuit as documented below.

serviceProviderProperties supports the following:

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

peerings supports the following:

  • peeringType - The type of the ExpressRoute Circuit Peering. Acceptable values include azurePrivatePeering, azurePublicPeering and microsoftPeering. Changing this forces a new resource to be created.

\~> Note: only one Peering of each Type can be created per ExpressRoute circuit.

  • primaryPeerAddressPrefix - A /30 subnet for the primary link.
  • secondaryPeerAddressPrefix - A /30 subnet for the secondary link.
  • vlanId - A valid VLAN ID to establish this peering on.
  • sharedKey - The shared key. Can be a maximum of 25 characters.
  • azureAsn - The Either a 16-bit or a 32-bit ASN for Azure.
  • peerAsn - The Either a 16-bit or a 32-bit ASN. Can either be public or private.

sku supports the following:

  • tier - The service tier. Possible values are basic, local, standard or premium.
  • family - The billing mode for bandwidth. Possible values are meteredData or unlimitedData.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the ExpressRoute circuit.