Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getExpressRouteConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getExpressRouteConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified ExpressRouteConnection.

Uses Azure REST API version 2024-05-01.

Other available API versions: 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. 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 for details.

Using getExpressRouteConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getExpressRouteConnection(args: GetExpressRouteConnectionArgs, opts?: InvokeOptions): Promise<GetExpressRouteConnectionResult>
function getExpressRouteConnectionOutput(args: GetExpressRouteConnectionOutputArgs, opts?: InvokeOptions): Output<GetExpressRouteConnectionResult>
Copy
def get_express_route_connection(connection_name: Optional[str] = None,
                                 express_route_gateway_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetExpressRouteConnectionResult
def get_express_route_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                                 express_route_gateway_name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetExpressRouteConnectionResult]
Copy
func LookupExpressRouteConnection(ctx *Context, args *LookupExpressRouteConnectionArgs, opts ...InvokeOption) (*LookupExpressRouteConnectionResult, error)
func LookupExpressRouteConnectionOutput(ctx *Context, args *LookupExpressRouteConnectionOutputArgs, opts ...InvokeOption) LookupExpressRouteConnectionResultOutput
Copy

> Note: This function is named LookupExpressRouteConnection in the Go SDK.

public static class GetExpressRouteConnection 
{
    public static Task<GetExpressRouteConnectionResult> InvokeAsync(GetExpressRouteConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetExpressRouteConnectionResult> Invoke(GetExpressRouteConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExpressRouteConnectionResult> getExpressRouteConnection(GetExpressRouteConnectionArgs args, InvokeOptions options)
public static Output<GetExpressRouteConnectionResult> getExpressRouteConnection(GetExpressRouteConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getExpressRouteConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRoute connection.
ExpressRouteGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRoute gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRoute connection.
ExpressRouteGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRoute gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressRoute connection.
expressRouteGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressRoute gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
connectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRoute connection.
expressRouteGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ExpressRoute gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ExpressRoute connection.
express_route_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ExpressRoute gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressRoute connection.
expressRouteGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ExpressRoute gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getExpressRouteConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ExpressRouteCircuitPeering Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitPeeringIdResponse
The ExpressRoute circuit peering.
Name string
The name of the resource.
ProvisioningState string
The provisioning state of the express route connection resource.
AuthorizationKey string
Authorization key to establish the connection.
EnableInternetSecurity bool
Enable internet security.
EnablePrivateLinkFastPath bool
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
ExpressRouteGatewayBypass bool
Enable FastPath to vWan Firewall hub.
Id string
Resource ID.
RoutingConfiguration Pulumi.AzureNative.Network.Outputs.RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingWeight int
The routing weight associated to the connection.
AzureApiVersion string
The Azure API version of the resource.
ExpressRouteCircuitPeering ExpressRouteCircuitPeeringIdResponse
The ExpressRoute circuit peering.
Name string
The name of the resource.
ProvisioningState string
The provisioning state of the express route connection resource.
AuthorizationKey string
Authorization key to establish the connection.
EnableInternetSecurity bool
Enable internet security.
EnablePrivateLinkFastPath bool
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
ExpressRouteGatewayBypass bool
Enable FastPath to vWan Firewall hub.
Id string
Resource ID.
RoutingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingWeight int
The routing weight associated to the connection.
azureApiVersion String
The Azure API version of the resource.
expressRouteCircuitPeering ExpressRouteCircuitPeeringIdResponse
The ExpressRoute circuit peering.
name String
The name of the resource.
provisioningState String
The provisioning state of the express route connection resource.
authorizationKey String
Authorization key to establish the connection.
enableInternetSecurity Boolean
Enable internet security.
enablePrivateLinkFastPath Boolean
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
expressRouteGatewayBypass Boolean
Enable FastPath to vWan Firewall hub.
id String
Resource ID.
routingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight Integer
The routing weight associated to the connection.
azureApiVersion string
The Azure API version of the resource.
expressRouteCircuitPeering ExpressRouteCircuitPeeringIdResponse
The ExpressRoute circuit peering.
name string
The name of the resource.
provisioningState string
The provisioning state of the express route connection resource.
authorizationKey string
Authorization key to establish the connection.
enableInternetSecurity boolean
Enable internet security.
enablePrivateLinkFastPath boolean
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
expressRouteGatewayBypass boolean
Enable FastPath to vWan Firewall hub.
id string
Resource ID.
routingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight number
The routing weight associated to the connection.
azure_api_version str
The Azure API version of the resource.
express_route_circuit_peering ExpressRouteCircuitPeeringIdResponse
The ExpressRoute circuit peering.
name str
The name of the resource.
provisioning_state str
The provisioning state of the express route connection resource.
authorization_key str
Authorization key to establish the connection.
enable_internet_security bool
Enable internet security.
enable_private_link_fast_path bool
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
express_route_gateway_bypass bool
Enable FastPath to vWan Firewall hub.
id str
Resource ID.
routing_configuration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
routing_weight int
The routing weight associated to the connection.
azureApiVersion String
The Azure API version of the resource.
expressRouteCircuitPeering Property Map
The ExpressRoute circuit peering.
name String
The name of the resource.
provisioningState String
The provisioning state of the express route connection resource.
authorizationKey String
Authorization key to establish the connection.
enableInternetSecurity Boolean
Enable internet security.
enablePrivateLinkFastPath Boolean
Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
expressRouteGatewayBypass Boolean
Enable FastPath to vWan Firewall hub.
id String
Resource ID.
routingConfiguration Property Map
The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight Number
The routing weight associated to the connection.

Supporting Types

ExpressRouteCircuitPeeringIdResponse

Id string
The ID of the ExpressRoute circuit peering.
Id string
The ID of the ExpressRoute circuit peering.
id String
The ID of the ExpressRoute circuit peering.
id string
The ID of the ExpressRoute circuit peering.
id str
The ID of the ExpressRoute circuit peering.
id String
The ID of the ExpressRoute circuit peering.

PropagatedRouteTableResponse

Ids List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
The list of resource ids of all the RouteTables.
Labels List<string>
The list of labels.
Ids []SubResourceResponse
The list of resource ids of all the RouteTables.
Labels []string
The list of labels.
ids List<SubResourceResponse>
The list of resource ids of all the RouteTables.
labels List<String>
The list of labels.
ids SubResourceResponse[]
The list of resource ids of all the RouteTables.
labels string[]
The list of labels.
ids Sequence[SubResourceResponse]
The list of resource ids of all the RouteTables.
labels Sequence[str]
The list of labels.
ids List<Property Map>
The list of resource ids of all the RouteTables.
labels List<String>
The list of labels.

RoutingConfigurationResponse

AssociatedRouteTable Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
InboundRouteMap Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
OutboundRouteMap Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
PropagatedRouteTables Pulumi.AzureNative.Network.Inputs.PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
VnetRoutes Pulumi.AzureNative.Network.Inputs.VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
AssociatedRouteTable SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
InboundRouteMap SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
OutboundRouteMap SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
PropagatedRouteTables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
VnetRoutes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associatedRouteTable SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
vnetRoutes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associatedRouteTable SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
vnetRoutes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associated_route_table SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
inbound_route_map SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outbound_route_map SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagated_route_tables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
vnet_routes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associatedRouteTable Property Map
The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap Property Map
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap Property Map
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables Property Map
The list of RouteTables to advertise the routes to.
vnetRoutes Property Map
List of routes that control routing from VirtualHub into a virtual network connection.

StaticRouteResponse

AddressPrefixes List<string>
List of all address prefixes.
Name string
The name of the StaticRoute that is unique within a VnetRoute.
NextHopIpAddress string
The ip address of the next hop.
AddressPrefixes []string
List of all address prefixes.
Name string
The name of the StaticRoute that is unique within a VnetRoute.
NextHopIpAddress string
The ip address of the next hop.
addressPrefixes List<String>
List of all address prefixes.
name String
The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress String
The ip address of the next hop.
addressPrefixes string[]
List of all address prefixes.
name string
The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress string
The ip address of the next hop.
address_prefixes Sequence[str]
List of all address prefixes.
name str
The name of the StaticRoute that is unique within a VnetRoute.
next_hop_ip_address str
The ip address of the next hop.
addressPrefixes List<String>
List of all address prefixes.
name String
The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress String
The ip address of the next hop.

StaticRoutesConfigResponse

PropagateStaticRoutes This property is required. bool
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
VnetLocalRouteOverrideCriteria string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
PropagateStaticRoutes This property is required. bool
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
VnetLocalRouteOverrideCriteria string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagateStaticRoutes This property is required. Boolean
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria String
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagateStaticRoutes This property is required. boolean
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagate_static_routes This property is required. bool
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnet_local_route_override_criteria str
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagateStaticRoutes This property is required. Boolean
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria String
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

VnetRouteResponse

BgpConnections This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
The list of references to HubBgpConnection objects.
StaticRoutes List<Pulumi.AzureNative.Network.Inputs.StaticRouteResponse>
List of all Static Routes.
StaticRoutesConfig Pulumi.AzureNative.Network.Inputs.StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
BgpConnections This property is required. []SubResourceResponse
The list of references to HubBgpConnection objects.
StaticRoutes []StaticRouteResponse
List of all Static Routes.
StaticRoutesConfig StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgpConnections This property is required. List<SubResourceResponse>
The list of references to HubBgpConnection objects.
staticRoutes List<StaticRouteResponse>
List of all Static Routes.
staticRoutesConfig StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgpConnections This property is required. SubResourceResponse[]
The list of references to HubBgpConnection objects.
staticRoutes StaticRouteResponse[]
List of all Static Routes.
staticRoutesConfig StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgp_connections This property is required. Sequence[SubResourceResponse]
The list of references to HubBgpConnection objects.
static_routes Sequence[StaticRouteResponse]
List of all Static Routes.
static_routes_config StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgpConnections This property is required. List<Property Map>
The list of references to HubBgpConnection objects.
staticRoutes List<Property Map>
List of all Static Routes.
staticRoutesConfig Property Map
Configuration for static routes on this HubVnetConnection.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native