1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. ExpressRouteCircuit

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.network.ExpressRouteCircuit

Explore with Pulumi AI

Manages an ExpressRoute circuit.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "exprtTest",
    location: "West Europe",
});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("example", {
    name: "expressRoute1",
    resourceGroupName: example.name,
    location: example.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    tags: {
        environment: "Production",
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="exprtTest",
    location="West Europe")
example_express_route_circuit = azure.network.ExpressRouteCircuit("example",
    name="expressRoute1",
    resource_group_name=example.name,
    location=example.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    tags={
        "environment": "Production",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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 := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("exprtTest"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewExpressRouteCircuit(ctx, "example", &network.ExpressRouteCircuitArgs{
			Name:                pulumi.String("expressRoute1"),
			ResourceGroupName:   example.Name,
			Location:            example.Location,
			ServiceProviderName: pulumi.String("Equinix"),
			PeeringLocation:     pulumi.String("Silicon Valley"),
			BandwidthInMbps:     pulumi.Int(50),
			Sku: &network.ExpressRouteCircuitSkuArgs{
				Tier:   pulumi.String("Standard"),
				Family: pulumi.String("MeteredData"),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "exprtTest",
        Location = "West Europe",
    });

    var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("example", new()
    {
        Name = "expressRoute1",
        ResourceGroupName = example.Name,
        Location = example.Location,
        ServiceProviderName = "Equinix",
        PeeringLocation = "Silicon Valley",
        BandwidthInMbps = 50,
        Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
        {
            Tier = "Standard",
            Family = "MeteredData",
        },
        Tags = 
        {
            { "environment", "Production" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.ExpressRouteCircuit;
import com.pulumi.azure.network.ExpressRouteCircuitArgs;
import com.pulumi.azure.network.inputs.ExpressRouteCircuitSkuArgs;
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) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("exprtTest")
            .location("West Europe")
            .build());

        var exampleExpressRouteCircuit = new ExpressRouteCircuit("exampleExpressRouteCircuit", ExpressRouteCircuitArgs.builder()
            .name("expressRoute1")
            .resourceGroupName(example.name())
            .location(example.location())
            .serviceProviderName("Equinix")
            .peeringLocation("Silicon Valley")
            .bandwidthInMbps(50)
            .sku(ExpressRouteCircuitSkuArgs.builder()
                .tier("Standard")
                .family("MeteredData")
                .build())
            .tags(Map.of("environment", "Production"))
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: exprtTest
      location: West Europe
  exampleExpressRouteCircuit:
    type: azure:network:ExpressRouteCircuit
    name: example
    properties:
      name: expressRoute1
      resourceGroupName: ${example.name}
      location: ${example.location}
      serviceProviderName: Equinix
      peeringLocation: Silicon Valley
      bandwidthInMbps: 50
      sku:
        tier: Standard
        family: MeteredData
      tags:
        environment: Production
Copy

Create ExpressRouteCircuit Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ExpressRouteCircuit(name: string, args: ExpressRouteCircuitArgs, opts?: CustomResourceOptions);
@overload
def ExpressRouteCircuit(resource_name: str,
                        args: ExpressRouteCircuitArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ExpressRouteCircuit(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        resource_group_name: Optional[str] = None,
                        sku: Optional[ExpressRouteCircuitSkuArgs] = None,
                        bandwidth_in_mbps: Optional[int] = None,
                        allow_classic_operations: Optional[bool] = None,
                        express_route_port_id: Optional[str] = None,
                        location: Optional[str] = None,
                        name: Optional[str] = None,
                        peering_location: Optional[str] = None,
                        rate_limiting_enabled: Optional[bool] = None,
                        bandwidth_in_gbps: Optional[float] = None,
                        service_provider_name: Optional[str] = None,
                        authorization_key: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
func NewExpressRouteCircuit(ctx *Context, name string, args ExpressRouteCircuitArgs, opts ...ResourceOption) (*ExpressRouteCircuit, error)
public ExpressRouteCircuit(string name, ExpressRouteCircuitArgs args, CustomResourceOptions? opts = null)
public ExpressRouteCircuit(String name, ExpressRouteCircuitArgs args)
public ExpressRouteCircuit(String name, ExpressRouteCircuitArgs args, CustomResourceOptions options)
type: azure:network:ExpressRouteCircuit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteCircuitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ExpressRouteCircuitArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteCircuitArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ExpressRouteCircuitArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ExpressRouteCircuitArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var expressRouteCircuitResource = new Azure.Network.ExpressRouteCircuit("expressRouteCircuitResource", new()
{
    ResourceGroupName = "string",
    Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
    {
        Family = "string",
        Tier = "string",
    },
    BandwidthInMbps = 0,
    AllowClassicOperations = false,
    ExpressRoutePortId = "string",
    Location = "string",
    Name = "string",
    PeeringLocation = "string",
    RateLimitingEnabled = false,
    BandwidthInGbps = 0,
    ServiceProviderName = "string",
    AuthorizationKey = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := network.NewExpressRouteCircuit(ctx, "expressRouteCircuitResource", &network.ExpressRouteCircuitArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku: &network.ExpressRouteCircuitSkuArgs{
		Family: pulumi.String("string"),
		Tier:   pulumi.String("string"),
	},
	BandwidthInMbps:        pulumi.Int(0),
	AllowClassicOperations: pulumi.Bool(false),
	ExpressRoutePortId:     pulumi.String("string"),
	Location:               pulumi.String("string"),
	Name:                   pulumi.String("string"),
	PeeringLocation:        pulumi.String("string"),
	RateLimitingEnabled:    pulumi.Bool(false),
	BandwidthInGbps:        pulumi.Float64(0),
	ServiceProviderName:    pulumi.String("string"),
	AuthorizationKey:       pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var expressRouteCircuitResource = new ExpressRouteCircuit("expressRouteCircuitResource", ExpressRouteCircuitArgs.builder()
    .resourceGroupName("string")
    .sku(ExpressRouteCircuitSkuArgs.builder()
        .family("string")
        .tier("string")
        .build())
    .bandwidthInMbps(0)
    .allowClassicOperations(false)
    .expressRoutePortId("string")
    .location("string")
    .name("string")
    .peeringLocation("string")
    .rateLimitingEnabled(false)
    .bandwidthInGbps(0)
    .serviceProviderName("string")
    .authorizationKey("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
express_route_circuit_resource = azure.network.ExpressRouteCircuit("expressRouteCircuitResource",
    resource_group_name="string",
    sku={
        "family": "string",
        "tier": "string",
    },
    bandwidth_in_mbps=0,
    allow_classic_operations=False,
    express_route_port_id="string",
    location="string",
    name="string",
    peering_location="string",
    rate_limiting_enabled=False,
    bandwidth_in_gbps=0,
    service_provider_name="string",
    authorization_key="string",
    tags={
        "string": "string",
    })
Copy
const expressRouteCircuitResource = new azure.network.ExpressRouteCircuit("expressRouteCircuitResource", {
    resourceGroupName: "string",
    sku: {
        family: "string",
        tier: "string",
    },
    bandwidthInMbps: 0,
    allowClassicOperations: false,
    expressRoutePortId: "string",
    location: "string",
    name: "string",
    peeringLocation: "string",
    rateLimitingEnabled: false,
    bandwidthInGbps: 0,
    serviceProviderName: "string",
    authorizationKey: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:network:ExpressRouteCircuit
properties:
    allowClassicOperations: false
    authorizationKey: string
    bandwidthInGbps: 0
    bandwidthInMbps: 0
    expressRoutePortId: string
    location: string
    name: string
    peeringLocation: string
    rateLimitingEnabled: false
    resourceGroupName: string
    serviceProviderName: string
    sku:
        family: string
        tier: string
    tags:
        string: string
Copy

ExpressRouteCircuit Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ExpressRouteCircuit resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
Sku This property is required. ExpressRouteCircuitSku
A sku block for the ExpressRoute circuit as documented below.
AllowClassicOperations bool
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
AuthorizationKey string
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
BandwidthInGbps double

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

BandwidthInMbps int

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

ExpressRoutePortId Changes to this property will trigger replacement. string
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
PeeringLocation Changes to this property will trigger replacement. string
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
RateLimitingEnabled bool
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
ServiceProviderName Changes to this property will trigger replacement. string
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
Sku This property is required. ExpressRouteCircuitSkuArgs
A sku block for the ExpressRoute circuit as documented below.
AllowClassicOperations bool
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
AuthorizationKey string
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
BandwidthInGbps float64

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

BandwidthInMbps int

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

ExpressRoutePortId Changes to this property will trigger replacement. string
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
PeeringLocation Changes to this property will trigger replacement. string
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
RateLimitingEnabled bool
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
ServiceProviderName Changes to this property will trigger replacement. string
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
sku This property is required. ExpressRouteCircuitSku
A sku block for the ExpressRoute circuit as documented below.
allowClassicOperations Boolean
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorizationKey String
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidthInGbps Double

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidthInMbps Integer

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

expressRoutePortId Changes to this property will trigger replacement. String
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation Changes to this property will trigger replacement. String
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rateLimitingEnabled Boolean
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
serviceProviderName Changes to this property will trigger replacement. String
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
sku This property is required. ExpressRouteCircuitSku
A sku block for the ExpressRoute circuit as documented below.
allowClassicOperations boolean
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorizationKey string
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidthInGbps number

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidthInMbps number

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

expressRoutePortId Changes to this property will trigger replacement. string
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation Changes to this property will trigger replacement. string
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rateLimitingEnabled boolean
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
serviceProviderName Changes to this property will trigger replacement. string
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
sku This property is required. ExpressRouteCircuitSkuArgs
A sku block for the ExpressRoute circuit as documented below.
allow_classic_operations bool
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorization_key str
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidth_in_gbps float

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidth_in_mbps int

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

express_route_port_id Changes to this property will trigger replacement. str
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peering_location Changes to this property will trigger replacement. str
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rate_limiting_enabled bool
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
service_provider_name Changes to this property will trigger replacement. str
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
sku This property is required. Property Map
A sku block for the ExpressRoute circuit as documented below.
allowClassicOperations Boolean
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorizationKey String
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidthInGbps Number

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidthInMbps Number

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

expressRoutePortId Changes to this property will trigger replacement. String
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation Changes to this property will trigger replacement. String
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rateLimitingEnabled Boolean
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
serviceProviderName Changes to this property will trigger replacement. String
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ExpressRouteCircuit resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
ServiceKey string
The string needed by the service provider to provision the ExpressRoute circuit.
ServiceProviderProvisioningState string
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
Id string
The provider-assigned unique ID for this managed resource.
ServiceKey string
The string needed by the service provider to provision the ExpressRoute circuit.
ServiceProviderProvisioningState string
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
id String
The provider-assigned unique ID for this managed resource.
serviceKey String
The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderProvisioningState String
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
id string
The provider-assigned unique ID for this managed resource.
serviceKey string
The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderProvisioningState string
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
id str
The provider-assigned unique ID for this managed resource.
service_key str
The string needed by the service provider to provision the ExpressRoute circuit.
service_provider_provisioning_state str
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
id String
The provider-assigned unique ID for this managed resource.
serviceKey String
The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderProvisioningState String
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.

Look up Existing ExpressRouteCircuit Resource

Get an existing ExpressRouteCircuit resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ExpressRouteCircuitState, opts?: CustomResourceOptions): ExpressRouteCircuit
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_classic_operations: Optional[bool] = None,
        authorization_key: Optional[str] = None,
        bandwidth_in_gbps: Optional[float] = None,
        bandwidth_in_mbps: Optional[int] = None,
        express_route_port_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        peering_location: Optional[str] = None,
        rate_limiting_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        service_key: Optional[str] = None,
        service_provider_name: Optional[str] = None,
        service_provider_provisioning_state: Optional[str] = None,
        sku: Optional[ExpressRouteCircuitSkuArgs] = None,
        tags: Optional[Mapping[str, str]] = None) -> ExpressRouteCircuit
func GetExpressRouteCircuit(ctx *Context, name string, id IDInput, state *ExpressRouteCircuitState, opts ...ResourceOption) (*ExpressRouteCircuit, error)
public static ExpressRouteCircuit Get(string name, Input<string> id, ExpressRouteCircuitState? state, CustomResourceOptions? opts = null)
public static ExpressRouteCircuit get(String name, Output<String> id, ExpressRouteCircuitState state, CustomResourceOptions options)
resources:  _:    type: azure:network:ExpressRouteCircuit    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllowClassicOperations bool
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
AuthorizationKey string
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
BandwidthInGbps double

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

BandwidthInMbps int

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

ExpressRoutePortId Changes to this property will trigger replacement. string
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
PeeringLocation Changes to this property will trigger replacement. string
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
RateLimitingEnabled bool
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
ServiceKey string
The string needed by the service provider to provision the ExpressRoute circuit.
ServiceProviderName Changes to this property will trigger replacement. string
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
ServiceProviderProvisioningState string
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
Sku ExpressRouteCircuitSku
A sku block for the ExpressRoute circuit as documented below.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
AllowClassicOperations bool
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
AuthorizationKey string
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
BandwidthInGbps float64

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

BandwidthInMbps int

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

ExpressRoutePortId Changes to this property will trigger replacement. string
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
PeeringLocation Changes to this property will trigger replacement. string
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
RateLimitingEnabled bool
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
ServiceKey string
The string needed by the service provider to provision the ExpressRoute circuit.
ServiceProviderName Changes to this property will trigger replacement. string
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
ServiceProviderProvisioningState string
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
Sku ExpressRouteCircuitSkuArgs
A sku block for the ExpressRoute circuit as documented below.
Tags map[string]string
A mapping of tags to assign to the resource.
allowClassicOperations Boolean
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorizationKey String
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidthInGbps Double

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidthInMbps Integer

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

expressRoutePortId Changes to this property will trigger replacement. String
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation Changes to this property will trigger replacement. String
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rateLimitingEnabled Boolean
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
serviceKey String
The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderName Changes to this property will trigger replacement. String
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
serviceProviderProvisioningState String
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
sku ExpressRouteCircuitSku
A sku block for the ExpressRoute circuit as documented below.
tags Map<String,String>
A mapping of tags to assign to the resource.
allowClassicOperations boolean
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorizationKey string
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidthInGbps number

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidthInMbps number

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

expressRoutePortId Changes to this property will trigger replacement. string
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation Changes to this property will trigger replacement. string
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rateLimitingEnabled boolean
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
serviceKey string
The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderName Changes to this property will trigger replacement. string
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
serviceProviderProvisioningState string
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
sku ExpressRouteCircuitSku
A sku block for the ExpressRoute circuit as documented below.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
allow_classic_operations bool
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorization_key str
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidth_in_gbps float

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidth_in_mbps int

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

express_route_port_id Changes to this property will trigger replacement. str
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peering_location Changes to this property will trigger replacement. str
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rate_limiting_enabled bool
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
service_key str
The string needed by the service provider to provision the ExpressRoute circuit.
service_provider_name Changes to this property will trigger replacement. str
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
service_provider_provisioning_state str
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
sku ExpressRouteCircuitSkuArgs
A sku block for the ExpressRoute circuit as documented below.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
allowClassicOperations Boolean
Allow the circuit to interact with classic (RDFE) resources. Defaults to false.
authorizationKey String
The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription.
bandwidthInGbps Number

The bandwidth in Gbps of the circuit being created on the Express Route Port.

NOTE: The express_route_port_id and the bandwidth_in_gbps should be set together and they conflict with service_provider_name, peering_location and bandwidth_in_mbps.

bandwidthInMbps Number

The bandwidth in Mbps of the circuit being created on the Service Provider.

NOTE: Once you increase your bandwidth, you will not be able to decrease it to its previous value.

NOTE: The service_provider_name, the peering_location and the bandwidth_in_mbps should be set together and they conflict with express_route_port_id and bandwidth_in_gbps.

expressRoutePortId Changes to this property will trigger replacement. String
The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation Changes to this property will trigger replacement. String
The name of the peering location and not the Azure resource location. Changing this forces a new resource to be created.
rateLimitingEnabled Boolean
Enable rate limiting for the circuit. Only works with ExpressRoute Ports. Defaults to false.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
serviceKey String
The string needed by the service provider to provision the ExpressRoute circuit.
serviceProviderName Changes to this property will trigger replacement. String
The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created.
serviceProviderProvisioningState String
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are NotProvisioned, Provisioning, Provisioned, and Deprovisioning.
sku Property Map
A sku block for the ExpressRoute circuit as documented below.
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

ExpressRouteCircuitSku
, ExpressRouteCircuitSkuArgs

Family This property is required. string

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

NOTE: You can migrate from MeteredData to UnlimitedData, but not the other way around.

Tier This property is required. string
The service tier. Possible values are Basic, Local, Standard or Premium.
Family This property is required. string

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

NOTE: You can migrate from MeteredData to UnlimitedData, but not the other way around.

Tier This property is required. string
The service tier. Possible values are Basic, Local, Standard or Premium.
family This property is required. String

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

NOTE: You can migrate from MeteredData to UnlimitedData, but not the other way around.

tier This property is required. String
The service tier. Possible values are Basic, Local, Standard or Premium.
family This property is required. string

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

NOTE: You can migrate from MeteredData to UnlimitedData, but not the other way around.

tier This property is required. string
The service tier. Possible values are Basic, Local, Standard or Premium.
family This property is required. str

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

NOTE: You can migrate from MeteredData to UnlimitedData, but not the other way around.

tier This property is required. str
The service tier. Possible values are Basic, Local, Standard or Premium.
family This property is required. String

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

NOTE: You can migrate from MeteredData to UnlimitedData, but not the other way around.

tier This property is required. String
The service tier. Possible values are Basic, Local, Standard or Premium.

Import

ExpressRoute circuits can be imported using the resource id, e.g.

$ pulumi import azure:network/expressRouteCircuit:ExpressRouteCircuit myExpressRoute /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/expressRouteCircuits/myExpressRoute
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.