@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* ExpressRouteCircuit resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, 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 classic operations.
*/
readonly allowClassicOperations: pulumi.Output<boolean | undefined>;
/**
* The authorizationKey.
*/
readonly authorizationKey: pulumi.Output<string | undefined>;
/**
* The authorization status of the Circuit.
*/
readonly authorizationStatus: pulumi.Output<string>;
/**
* The list of authorizations.
*/
readonly authorizations: pulumi.Output<outputs.network.ExpressRouteCircuitAuthorizationResponse[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
*/
readonly bandwidthInGbps: pulumi.Output<number | undefined>;
/**
* The CircuitProvisioningState state of the resource.
*/
readonly circuitProvisioningState: pulumi.Output<string | undefined>;
/**
* Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
*/
readonly enableDirectPortRateLimit: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
*/
readonly expressRoutePort: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The GatewayManager Etag.
*/
readonly gatewayManagerEtag: pulumi.Output<string | undefined>;
/**
* Flag denoting global reach status.
*/
readonly globalReachEnabled: pulumi.Output<boolean | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The list of peerings.
*/
readonly peerings: pulumi.Output<outputs.network.ExpressRouteCircuitPeeringResponse[] | undefined>;
/**
* The provisioning state of the express route circuit resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The ServiceKey.
*/
readonly serviceKey: pulumi.Output<string | undefined>;
/**
* The ServiceProviderNotes.
*/
readonly serviceProviderNotes: pulumi.Output<string | undefined>;
/**
* The ServiceProviderProperties.
*/
readonly serviceProviderProperties: pulumi.Output<outputs.network.ExpressRouteCircuitServiceProviderPropertiesResponse | undefined>;
/**
* The ServiceProviderProvisioningState state of the resource.
*/
readonly serviceProviderProvisioningState: pulumi.Output<string | undefined>;
/**
* The SKU.
*/
readonly sku: pulumi.Output<outputs.network.ExpressRouteCircuitSkuResponse | undefined>;
/**
* The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
*/
readonly stag: pulumi.Output<number>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* 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);
}
/**
* The set of arguments for constructing a ExpressRouteCircuit resource.
*/
export interface ExpressRouteCircuitArgs {
/**
* Allow classic operations.
*/
allowClassicOperations?: pulumi.Input<boolean>;
/**
* The authorizationKey.
*/
authorizationKey?: pulumi.Input<string>;
/**
* The list of authorizations.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
authorizations?: pulumi.Input<pulumi.Input<inputs.network.ExpressRouteCircuitAuthorizationArgs>[]>;
/**
* The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
*/
bandwidthInGbps?: pulumi.Input<number>;
/**
* The name of the circuit.
*/
circuitName?: pulumi.Input<string>;
/**
* The CircuitProvisioningState state of the resource.
*/
circuitProvisioningState?: pulumi.Input<string>;
/**
* Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
*/
enableDirectPortRateLimit?: pulumi.Input<boolean>;
/**
* The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
*/
expressRoutePort?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The GatewayManager Etag.
*/
gatewayManagerEtag?: pulumi.Input<string>;
/**
* Flag denoting global reach status.
*/
globalReachEnabled?: pulumi.Input<boolean>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The list of peerings.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
peerings?: pulumi.Input<pulumi.Input<inputs.network.ExpressRouteCircuitPeeringArgs>[]>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The ServiceKey.
*/
serviceKey?: pulumi.Input<string>;
/**
* The ServiceProviderNotes.
*/
serviceProviderNotes?: pulumi.Input<string>;
/**
* The ServiceProviderProperties.
*/
serviceProviderProperties?: pulumi.Input<inputs.network.ExpressRouteCircuitServiceProviderPropertiesArgs>;
/**
* The ServiceProviderProvisioningState state of the resource.
*/
serviceProviderProvisioningState?: pulumi.Input<string | enums.network.ServiceProviderProvisioningState>;
/**
* The SKU.
*/
sku?: pulumi.Input<inputs.network.ExpressRouteCircuitSkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}