Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getExpressRouteCircuitConnection
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getExpressRouteCircuitConnection

Explore with Pulumi AI

azure-native logo
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified Express Route Circuit Connection from 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. 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 getExpressRouteCircuitConnection

    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 getExpressRouteCircuitConnection(args: GetExpressRouteCircuitConnectionArgs, opts?: InvokeOptions): Promise<GetExpressRouteCircuitConnectionResult>
function getExpressRouteCircuitConnectionOutput(args: GetExpressRouteCircuitConnectionOutputArgs, opts?: InvokeOptions): Output<GetExpressRouteCircuitConnectionResult>
    def get_express_route_circuit_connection(circuit_name: Optional[str] = None,
                                         connection_name: Optional[str] = None,
                                         peering_name: Optional[str] = None,
                                         resource_group_name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetExpressRouteCircuitConnectionResult
def get_express_route_circuit_connection_output(circuit_name: Optional[pulumi.Input[str]] = None,
                                         connection_name: Optional[pulumi.Input[str]] = None,
                                         peering_name: Optional[pulumi.Input[str]] = None,
                                         resource_group_name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetExpressRouteCircuitConnectionResult]
    func LookupExpressRouteCircuitConnection(ctx *Context, args *LookupExpressRouteCircuitConnectionArgs, opts ...InvokeOption) (*LookupExpressRouteCircuitConnectionResult, error)
func LookupExpressRouteCircuitConnectionOutput(ctx *Context, args *LookupExpressRouteCircuitConnectionOutputArgs, opts ...InvokeOption) LookupExpressRouteCircuitConnectionResultOutput

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

    public static class GetExpressRouteCircuitConnection 
{
    public static Task<GetExpressRouteCircuitConnectionResult> InvokeAsync(GetExpressRouteCircuitConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetExpressRouteCircuitConnectionResult> Invoke(GetExpressRouteCircuitConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExpressRouteCircuitConnectionResult> getExpressRouteCircuitConnection(GetExpressRouteCircuitConnectionArgs args, InvokeOptions options)
public static Output<GetExpressRouteCircuitConnectionResult> getExpressRouteCircuitConnection(GetExpressRouteCircuitConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getExpressRouteCircuitConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CircuitName string
    The name of the express route circuit.
    ConnectionName string
    The name of the express route circuit connection.
    PeeringName string
    The name of the peering.
    ResourceGroupName string
    The name of the resource group.
    CircuitName string
    The name of the express route circuit.
    ConnectionName string
    The name of the express route circuit connection.
    PeeringName string
    The name of the peering.
    ResourceGroupName string
    The name of the resource group.
    circuitName String
    The name of the express route circuit.
    connectionName String
    The name of the express route circuit connection.
    peeringName String
    The name of the peering.
    resourceGroupName String
    The name of the resource group.
    circuitName string
    The name of the express route circuit.
    connectionName string
    The name of the express route circuit connection.
    peeringName string
    The name of the peering.
    resourceGroupName string
    The name of the resource group.
    circuit_name str
    The name of the express route circuit.
    connection_name str
    The name of the express route circuit connection.
    peering_name str
    The name of the peering.
    resource_group_name str
    The name of the resource group.
    circuitName String
    The name of the express route circuit.
    connectionName String
    The name of the express route circuit connection.
    peeringName String
    The name of the peering.
    resourceGroupName String
    The name of the resource group.

    getExpressRouteCircuitConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    CircuitConnectionStatus string
    Express Route Circuit connection state.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the express route circuit connection resource.
    Type string
    Type of the resource.
    AddressPrefix string
    /29 IP address space to carve out Customer addresses for tunnels.
    AuthorizationKey string
    The authorization key.
    ExpressRouteCircuitPeering Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
    Id string
    Resource ID.
    Ipv6CircuitConnectionConfig Pulumi.AzureNative.Network.Outputs.Ipv6CircuitConnectionConfigResponse
    IPv6 Address PrefixProperties of the express route circuit connection.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    PeerExpressRouteCircuitPeering Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the peered circuit.
    AzureApiVersion string
    The Azure API version of the resource.
    CircuitConnectionStatus string
    Express Route Circuit connection state.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the express route circuit connection resource.
    Type string
    Type of the resource.
    AddressPrefix string
    /29 IP address space to carve out Customer addresses for tunnels.
    AuthorizationKey string
    The authorization key.
    ExpressRouteCircuitPeering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
    Id string
    Resource ID.
    Ipv6CircuitConnectionConfig Ipv6CircuitConnectionConfigResponse
    IPv6 Address PrefixProperties of the express route circuit connection.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    PeerExpressRouteCircuitPeering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the peered circuit.
    azureApiVersion String
    The Azure API version of the resource.
    circuitConnectionStatus String
    Express Route Circuit connection state.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the express route circuit connection resource.
    type String
    Type of the resource.
    addressPrefix String
    /29 IP address space to carve out Customer addresses for tunnels.
    authorizationKey String
    The authorization key.
    expressRouteCircuitPeering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
    id String
    Resource ID.
    ipv6CircuitConnectionConfig Ipv6CircuitConnectionConfigResponse
    IPv6 Address PrefixProperties of the express route circuit connection.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    peerExpressRouteCircuitPeering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the peered circuit.
    azureApiVersion string
    The Azure API version of the resource.
    circuitConnectionStatus string
    Express Route Circuit connection state.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the express route circuit connection resource.
    type string
    Type of the resource.
    addressPrefix string
    /29 IP address space to carve out Customer addresses for tunnels.
    authorizationKey string
    The authorization key.
    expressRouteCircuitPeering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
    id string
    Resource ID.
    ipv6CircuitConnectionConfig Ipv6CircuitConnectionConfigResponse
    IPv6 Address PrefixProperties of the express route circuit connection.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    peerExpressRouteCircuitPeering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the peered circuit.
    azure_api_version str
    The Azure API version of the resource.
    circuit_connection_status str
    Express Route Circuit connection state.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the express route circuit connection resource.
    type str
    Type of the resource.
    address_prefix str
    /29 IP address space to carve out Customer addresses for tunnels.
    authorization_key str
    The authorization key.
    express_route_circuit_peering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
    id str
    Resource ID.
    ipv6_circuit_connection_config Ipv6CircuitConnectionConfigResponse
    IPv6 Address PrefixProperties of the express route circuit connection.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    peer_express_route_circuit_peering SubResourceResponse
    Reference to Express Route Circuit Private Peering Resource of the peered circuit.
    azureApiVersion String
    The Azure API version of the resource.
    circuitConnectionStatus String
    Express Route Circuit connection state.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the express route circuit connection resource.
    type String
    Type of the resource.
    addressPrefix String
    /29 IP address space to carve out Customer addresses for tunnels.
    authorizationKey String
    The authorization key.
    expressRouteCircuitPeering Property Map
    Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
    id String
    Resource ID.
    ipv6CircuitConnectionConfig Property Map
    IPv6 Address PrefixProperties of the express route circuit connection.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    peerExpressRouteCircuitPeering Property Map
    Reference to Express Route Circuit Private Peering Resource of the peered circuit.

    Supporting Types

    Ipv6CircuitConnectionConfigResponse

    CircuitConnectionStatus string
    Express Route Circuit connection state.
    AddressPrefix string
    /125 IP address space to carve out customer addresses for global reach.
    CircuitConnectionStatus string
    Express Route Circuit connection state.
    AddressPrefix string
    /125 IP address space to carve out customer addresses for global reach.
    circuitConnectionStatus String
    Express Route Circuit connection state.
    addressPrefix String
    /125 IP address space to carve out customer addresses for global reach.
    circuitConnectionStatus string
    Express Route Circuit connection state.
    addressPrefix string
    /125 IP address space to carve out customer addresses for global reach.
    circuit_connection_status str
    Express Route Circuit connection state.
    address_prefix str
    /125 IP address space to carve out customer addresses for global reach.
    circuitConnectionStatus String
    Express Route Circuit connection state.
    addressPrefix String
    /125 IP address space to carve out customer addresses for global reach.

    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.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native