peer_express_route_circuit_connections

Creates, updates, deletes, gets or lists a peer_express_route_circuit_connections resource.

Overview

Name	peer_express_route_circuit_connections
Type	Resource
Id	azure.network.peer_express_route_circuit_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
addressPrefix	string	/29 IP address space to carve out Customer addresses for tunnels.
authResourceGuid	string	The resource guid of the authorization used for the express route circuit connection.
circuitConnectionStatus	string	Express Route Circuit connection state. Known values are: "Connected", "Connecting", and "Disconnected". (Connected, Connecting, Disconnected)
connectionName	string	The name of the express route circuit connection resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuitPeering	object	Reference to another subresource.
peerExpressRouteCircuitPeering	object	Reference to another subresource.
provisioningState	string	The provisioning state of the peer express route circuit connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
addressPrefix	string	/29 IP address space to carve out Customer addresses for tunnels.
authResourceGuid	string	The resource guid of the authorization used for the express route circuit connection.
circuitConnectionStatus	string	Express Route Circuit connection state. Known values are: "Connected", "Connecting", and "Disconnected". (Connected, Connecting, Disconnected)
connectionName	string	The name of the express route circuit connection resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuitPeering	object	Reference to another subresource.
peerExpressRouteCircuitPeering	object	Reference to another subresource.
provisioningState	string	The provisioning state of the peer express route circuit connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, circuit_name, peering_name, connection_name, subscription_id		Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.
list	select	resource_group_name, circuit_name, peering_name, subscription_id		Gets all global reach peer connections associated with a private peering in an express route circuit.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
circuit_name	string	The name of express route circuit. Required.
connection_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
peering_name	string	The name of the peering. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.

SELECT
id,
name,
addressPrefix,
authResourceGuid,
circuitConnectionStatus,
connectionName,
etag,
expressRouteCircuitPeering,
peerExpressRouteCircuitPeering,
provisioningState,
type
FROM azure.network.peer_express_route_circuit_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all global reach peer connections associated with a private peering in an express route circuit.

SELECT
id,
name,
addressPrefix,
authResourceGuid,
circuitConnectionStatus,
connectionName,
etag,
expressRouteCircuitPeering,
peerExpressRouteCircuitPeering,
provisioningState,
type
FROM azure.network.peer_express_route_circuit_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;