Class 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" },
},
});
}
}
Inherited Members
Namespace: Pulumi.Azure.Network
Assembly: Pulumi.Azure.dll
Syntax
public class ExpressRouteCircuit : CustomResource
Constructors
View SourceExpressRouteCircuit(String, ExpressRouteCircuitArgs, CustomResourceOptions)
Create a ExpressRouteCircuit resource with the given unique name, arguments, and options.
Declaration
public ExpressRouteCircuit(string name, ExpressRouteCircuitArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| ExpressRouteCircuitArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAllowClassicOperations
Allow the circuit to interact with classic (RDFE) resources. The default value is false.
Declaration
public Output<bool?> AllowClassicOperations { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
BandwidthInMbps
The bandwidth in Mbps of the circuit being created.
Declaration
public Output<int> BandwidthInMbps { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Int32> |
Location
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Declaration
public Output<string> Location { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PeeringLocation
The name of the peering location and not the Azure resource location.
Declaration
public Output<string> PeeringLocation { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ResourceGroupName
The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
Declaration
public Output<string> ResourceGroupName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ServiceKey
The string needed by the service provider to provision the ExpressRoute circuit.
Declaration
public Output<string> ServiceKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ServiceProviderName
The name of the ExpressRoute Service Provider.
Declaration
public Output<string> ServiceProviderName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ServiceProviderProvisioningState
The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning".
Declaration
public Output<string> ServiceProviderProvisioningState { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Sku
A sku block for the ExpressRoute circuit as documented below.
Declaration
public Output<ExpressRouteCircuitSku> Sku { get; }
Property Value
| Type | Description |
|---|---|
| Output<ExpressRouteCircuitSku> |
Tags
A mapping of tags to assign to the resource.
Declaration
public Output<ImmutableDictionary<string, string>> Tags { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>> |
Methods
View SourceGet(String, Input<String>, ExpressRouteCircuitState, CustomResourceOptions)
Get an existing ExpressRouteCircuit resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static ExpressRouteCircuit Get(string name, Input<string> id, ExpressRouteCircuitState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| ExpressRouteCircuitState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| ExpressRouteCircuit |