» Data Source: azurerm_express_route_circuit

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

» Example Usage

data "azurerm_express_route_circuit" "example" {
  resource_group_name = azurerm_resource_group.example.name
  name                = azurerm_express_route_circuit.example.name

output "express_route_circuit_id" {
  value = data.azurerm_express_route_circuit.example.id

output "service_key" {
  value = data.azurerm_express_route_circuit.example.service_key

» Argument Reference

  • name - The name of the ExpressRoute circuit.
  • resource_group_name - 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

  • service_provider_provisioning_state - The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning".

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

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

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

service_provider_properties supports the following:

peerings supports the following:

  • peering_type - The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.

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.