1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getExpressRouteCircuitConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

azure-native-v2.network.getExpressRouteCircuitConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi

Gets the specified Express Route Circuit Connection from the specified express route circuit. Azure REST API version: 2023-02-01.

Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

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>
Copy
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]
Copy
func LookupExpressRouteCircuitConnection(ctx *Context, args *LookupExpressRouteCircuitConnectionArgs, opts ...InvokeOption) (*LookupExpressRouteCircuitConnectionResult, error)
func LookupExpressRouteCircuitConnectionOutput(ctx *Context, args *LookupExpressRouteCircuitConnectionOutputArgs, opts ...InvokeOption) LookupExpressRouteCircuitConnectionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetExpressRouteCircuitConnectionResult> getExpressRouteCircuitConnection(GetExpressRouteCircuitConnectionArgs args, InvokeOptions options)
public static Output<GetExpressRouteCircuitConnectionResult> getExpressRouteCircuitConnection(GetExpressRouteCircuitConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getExpressRouteCircuitConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit connection.
PeeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
CircuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit connection.
PeeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
circuitName
This property is required.
Changes to this property will trigger replacement.
String
The name of the express route circuit.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the express route circuit connection.
peeringName
This property is required.
Changes to this property will trigger replacement.
String
The name of the peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
circuitName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit.
connectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the express route circuit connection.
peeringName
This property is required.
Changes to this property will trigger replacement.
string
The name of the peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
circuit_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the express route circuit.
connection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the express route circuit connection.
peering_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the peering.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
circuitName
This property is required.
Changes to this property will trigger replacement.
String
The name of the express route circuit.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the express route circuit connection.
peeringName
This property is required.
Changes to this property will trigger replacement.
String
The name of the peering.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getExpressRouteCircuitConnection Result

The following output properties are available:

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.
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.
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.
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.
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.
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 This property is required. string
Express Route Circuit connection state.
AddressPrefix string
/125 IP address space to carve out customer addresses for global reach.
CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
AddressPrefix string
/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
addressPrefix String
/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus This property is required. string
Express Route Circuit connection state.
addressPrefix string
/125 IP address space to carve out customer addresses for global reach.
circuit_connection_status This property is required. str
Express Route Circuit connection state.
address_prefix str
/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
addressPrefix String
/125 IP address space to carve out customer addresses for global reach.

SubResourceResponse

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi