ExpressRouteCircuit

Manages an ExpressRoute circuit.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleExpressRouteCircuit = new Azure.Network.ExpressRouteCircuit("exampleExpressRouteCircuit", new Azure.Network.ExpressRouteCircuitArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            ServiceProviderName = "Equinix",
            PeeringLocation = "Silicon Valley",
            BandwidthInMbps = 50,
            Sku = new Azure.Network.Inputs.ExpressRouteCircuitSkuArgs
            {
                Tier = "Standard",
                Family = "MeteredData",
            },
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "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 {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West US"),
        })
        if err != nil {
            return err
        }
        _, err = network.NewExpressRouteCircuit(ctx, "exampleExpressRouteCircuit", &network.ExpressRouteCircuitArgs{
            ResourceGroupName:   exampleResourceGroup.Name,
            Location:            exampleResourceGroup.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.Map{
                "environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_express_route_circuit = azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    tags={
        "environment": "Production",
    })

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    tags: {
        environment: "Production",
    },
});

Create a ExpressRouteCircuit Resource

new ExpressRouteCircuit(name: string, args: ExpressRouteCircuitArgs, opts?: CustomResourceOptions);

def ExpressRouteCircuit(resource_name, opts=None, allow_classic_operations=None, bandwidth_in_mbps=None, location=None, name=None, peering_location=None, resource_group_name=None, service_provider_name=None, sku=None, tags=None, __props__=None);

func NewExpressRouteCircuit(ctx *Context, name string, args ExpressRouteCircuitArgs, opts ...ResourceOption) (*ExpressRouteCircuit, error)

public ExpressRouteCircuit(string name, ExpressRouteCircuitArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ExpressRouteCircuitArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ExpressRouteCircuitArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExpressRouteCircuitArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ExpressRouteCircuit Resource Properties

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

Inputs

The ExpressRouteCircuit resource accepts the following input properties:

BandwidthInMbps int: The bandwidth in Mbps of the circuit being created.
PeeringLocation string: The name of the peering location and not the Azure resource location.
ResourceGroupName string: The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
ServiceProviderName string: The name of the ExpressRoute Service Provider.
Sku ExpressRouteCircuitSkuArgs: A sku block for the ExpressRoute circuit as documented below.
AllowClassicOperations bool: Allow the circuit to interact with classic (RDFE) resources. The default value is false.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

BandwidthInMbps int: The bandwidth in Mbps of the circuit being created.
PeeringLocation string: The name of the peering location and not the Azure resource location.
ResourceGroupName string: The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
ServiceProviderName string: The name of the ExpressRoute Service Provider.
Sku ExpressRouteCircuitSku: A sku block for the ExpressRoute circuit as documented below.
AllowClassicOperations bool: Allow the circuit to interact with classic (RDFE) resources. The default value is false.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

bandwidthInMbps number: The bandwidth in Mbps of the circuit being created.
peeringLocation string: The name of the peering location and not the Azure resource location.
resourceGroupName string: The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
serviceProviderName string: The name of the ExpressRoute Service Provider.
sku ExpressRouteCircuitSku: A sku block for the ExpressRoute circuit as documented below.
allowClassicOperations boolean: Allow the circuit to interact with classic (RDFE) resources. The default value is false.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

bandwidth_in_mbps float: The bandwidth in Mbps of the circuit being created.
peering_location str: The name of the peering location and not the Azure resource location.
resource_group_name str: The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
service_provider_name str: The name of the ExpressRoute Service Provider.
sku Dict[ExpressRouteCircuitSku]: A sku block for the ExpressRoute circuit as documented below.
allow_classic_operations bool: Allow the circuit to interact with classic (RDFE) resources. The default value is false.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
tags Dict[str, str]: 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 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”.

Look up an 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

static get(resource_name, id, opts=None, allow_classic_operations=None, bandwidth_in_mbps=None, location=None, name=None, peering_location=None, resource_group_name=None, service_key=None, service_provider_name=None, service_provider_provisioning_state=None, sku=None, tags=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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. The default value is false.
BandwidthInMbps int: The bandwidth in Mbps of the circuit being created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
PeeringLocation string: The name of the peering location and not the Azure resource location.
ResourceGroupName 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 string: The name of the ExpressRoute Service Provider.
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 Dictionary<string, string>: A mapping of tags to assign to the resource.

AllowClassicOperations bool: Allow the circuit to interact with classic (RDFE) resources. The default value is false.
BandwidthInMbps int: The bandwidth in Mbps of the circuit being created.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
PeeringLocation string: The name of the peering location and not the Azure resource location.
ResourceGroupName 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 string: The name of the ExpressRoute Service Provider.
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. The default value is false.
bandwidthInMbps number: The bandwidth in Mbps of the circuit being created.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peeringLocation string: The name of the peering location and not the Azure resource location.
resourceGroupName 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 string: The name of the ExpressRoute Service Provider.
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. The default value is false.
bandwidth_in_mbps float: The bandwidth in Mbps of the circuit being created.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
peering_location str: The name of the peering location and not the Azure resource location.
resource_group_name 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 str: The name of the ExpressRoute Service Provider.
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[ExpressRouteCircuitSku]: A sku block for the ExpressRoute circuit as documented below.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

ExpressRouteCircuitSku

See the input and 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