@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets information about the specified express route circuit.
*
* Uses Azure REST API version 2024-05-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 function getExpressRouteCircuit(args: GetExpressRouteCircuitArgs, opts?: pulumi.InvokeOptions): Promise<GetExpressRouteCircuitResult>;
export interface GetExpressRouteCircuitArgs {
/**
* The name of express route circuit.
*/
circuitName: string;
/**
* The name of the resource group.
*/
resourceGroupName: string;
}
/**
* ExpressRouteCircuit resource.
*/
export interface GetExpressRouteCircuitResult {
/**
* Allow classic operations.
*/
readonly allowClassicOperations?: boolean;
/**
* The authorizationKey.
*/
readonly authorizationKey?: string;
/**
* The authorization status of the Circuit.
*/
readonly authorizationStatus: string;
/**
* The list of authorizations.
*/
readonly authorizations?: outputs.network.ExpressRouteCircuitAuthorizationResponse[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
*/
readonly bandwidthInGbps?: number;
/**
* The CircuitProvisioningState state of the resource.
*/
readonly circuitProvisioningState?: string;
/**
* Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
*/
readonly enableDirectPortRateLimit?: boolean;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
*/
readonly expressRoutePort?: outputs.network.SubResourceResponse;
/**
* The GatewayManager Etag.
*/
readonly gatewayManagerEtag?: string;
/**
* Flag denoting global reach status.
*/
readonly globalReachEnabled?: boolean;
/**
* Resource ID.
*/
readonly id?: string;
/**
* Resource location.
*/
readonly location?: string;
/**
* Resource name.
*/
readonly name: string;
/**
* The list of peerings.
*/
readonly peerings?: outputs.network.ExpressRouteCircuitPeeringResponse[];
/**
* The provisioning state of the express route circuit resource.
*/
readonly provisioningState: string;
/**
* The ServiceKey.
*/
readonly serviceKey?: string;
/**
* The ServiceProviderNotes.
*/
readonly serviceProviderNotes?: string;
/**
* The ServiceProviderProperties.
*/
readonly serviceProviderProperties?: outputs.network.ExpressRouteCircuitServiceProviderPropertiesResponse;
/**
* The ServiceProviderProvisioningState state of the resource.
*/
readonly serviceProviderProvisioningState?: string;
/**
* The SKU.
*/
readonly sku?: outputs.network.ExpressRouteCircuitSkuResponse;
/**
* The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
*/
readonly stag: number;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type.
*/
readonly type: string;
}
/**
* Gets information about the specified express route circuit.
*
* Uses Azure REST API version 2024-05-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 function getExpressRouteCircuitOutput(args: GetExpressRouteCircuitOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExpressRouteCircuitResult>;
export interface GetExpressRouteCircuitOutputArgs {
/**
* The name of express route circuit.
*/
circuitName: pulumi.Input<string>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
}