import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an ExpressRoute circuit. * * ## Example Usage * * ```typescript * 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", * }, * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Network` - 2025-01-01 * * ## Import * * ExpressRoute circuits can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:network/expressRouteCircuit:ExpressRouteCircuit myExpressRoute /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/expressRouteCircuits/myExpressRoute * ``` */ export declare class ExpressRouteCircuit extends pulumi.CustomResource { /** * Get an existing ExpressRouteCircuit resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ExpressRouteCircuitState, opts?: pulumi.CustomResourceOptions): ExpressRouteCircuit; /** * Returns true if the given object is an instance of ExpressRouteCircuit. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ExpressRouteCircuit; /** * Allow the circuit to interact with classic (RDFE) resources. Defaults to `false`. */ readonly allowClassicOperations: pulumi.Output; /** * The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription. */ readonly authorizationKey: pulumi.Output; /** * The bandwidth in Gbps of the circuit being created on the Express Route Port. * * > **Note:** The `expressRoutePortId` and the `bandwidthInGbps` should be set together and they conflict with `serviceProviderName`, `peeringLocation` and `bandwidthInMbps`. */ readonly bandwidthInGbps: pulumi.Output; /** * 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 `serviceProviderName`, the `peeringLocation` and the `bandwidthInMbps` should be set together and they conflict with `expressRoutePortId` and `bandwidthInGbps`. */ readonly bandwidthInMbps: pulumi.Output; /** * The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created. */ readonly expressRoutePortId: pulumi.Output; /** * Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * The name of the ExpressRoute circuit. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * The name of the peering location and **not** the Azure resource location. Changing this forces a new resource to be created. */ readonly peeringLocation: pulumi.Output; /** * Enable [rate limiting](https://learn.microsoft.com/en-us/azure/expressroute/rate-limit) for the circuit. Only works with ExpressRoute Ports. Defaults to `false`. */ readonly rateLimitingEnabled: pulumi.Output; /** * The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * The string needed by the service provider to provision the ExpressRoute circuit. */ readonly serviceKey: pulumi.Output; /** * The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created. */ readonly serviceProviderName: pulumi.Output; /** * The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are `NotProvisioned`, `Provisioning`, `Provisioned`, and `Deprovisioning`. */ readonly serviceProviderProvisioningState: pulumi.Output; /** * A `sku` block for the ExpressRoute circuit as documented below. */ readonly sku: pulumi.Output; /** * A mapping of tags to assign to the resource. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Create a ExpressRouteCircuit resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ExpressRouteCircuitArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ExpressRouteCircuit resources. */ export interface ExpressRouteCircuitState { /** * Allow the circuit to interact with classic (RDFE) resources. Defaults to `false`. */ allowClassicOperations?: pulumi.Input; /** * The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription. */ authorizationKey?: pulumi.Input; /** * The bandwidth in Gbps of the circuit being created on the Express Route Port. * * > **Note:** The `expressRoutePortId` and the `bandwidthInGbps` should be set together and they conflict with `serviceProviderName`, `peeringLocation` and `bandwidthInMbps`. */ bandwidthInGbps?: pulumi.Input; /** * 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 `serviceProviderName`, the `peeringLocation` and the `bandwidthInMbps` should be set together and they conflict with `expressRoutePortId` and `bandwidthInGbps`. */ bandwidthInMbps?: pulumi.Input; /** * The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created. */ expressRoutePortId?: pulumi.Input; /** * Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The name of the ExpressRoute circuit. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The name of the peering location and **not** the Azure resource location. Changing this forces a new resource to be created. */ peeringLocation?: pulumi.Input; /** * Enable [rate limiting](https://learn.microsoft.com/en-us/azure/expressroute/rate-limit) for the circuit. Only works with ExpressRoute Ports. Defaults to `false`. */ rateLimitingEnabled?: pulumi.Input; /** * The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * The string needed by the service provider to provision the ExpressRoute circuit. */ serviceKey?: pulumi.Input; /** * The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created. */ serviceProviderName?: pulumi.Input; /** * The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are `NotProvisioned`, `Provisioning`, `Provisioned`, and `Deprovisioning`. */ serviceProviderProvisioningState?: pulumi.Input; /** * A `sku` block for the ExpressRoute circuit as documented below. */ sku?: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; } /** * The set of arguments for constructing a ExpressRouteCircuit resource. */ export interface ExpressRouteCircuitArgs { /** * Allow the circuit to interact with classic (RDFE) resources. Defaults to `false`. */ allowClassicOperations?: pulumi.Input; /** * The authorization key. This can be used to set up an ExpressRoute Circuit with an ExpressRoute Port from another subscription. */ authorizationKey?: pulumi.Input; /** * The bandwidth in Gbps of the circuit being created on the Express Route Port. * * > **Note:** The `expressRoutePortId` and the `bandwidthInGbps` should be set together and they conflict with `serviceProviderName`, `peeringLocation` and `bandwidthInMbps`. */ bandwidthInGbps?: pulumi.Input; /** * 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 `serviceProviderName`, the `peeringLocation` and the `bandwidthInMbps` should be set together and they conflict with `expressRoutePortId` and `bandwidthInGbps`. */ bandwidthInMbps?: pulumi.Input; /** * The ID of the Express Route Port this Express Route Circuit is based on. Changing this forces a new resource to be created. */ expressRoutePortId?: pulumi.Input; /** * Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The name of the ExpressRoute circuit. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The name of the peering location and **not** the Azure resource location. Changing this forces a new resource to be created. */ peeringLocation?: pulumi.Input; /** * Enable [rate limiting](https://learn.microsoft.com/en-us/azure/expressroute/rate-limit) for the circuit. Only works with ExpressRoute Ports. Defaults to `false`. */ rateLimitingEnabled?: pulumi.Input; /** * The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * The name of the ExpressRoute Service Provider. Changing this forces a new resource to be created. */ serviceProviderName?: pulumi.Input; /** * A `sku` block for the ExpressRoute circuit as documented below. */ sku: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; }