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

Request successful. The operation returns the resulting Peer Express Route Circuit Connection resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the peer express route circuit connection.
type	string	Type of the resource.

list

Request successful. The operation returns a list of PeerExpressRouteCircuitConnections resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the peer express route circuit connection.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, circuitName, peeringName, connectionName, subscriptionId		Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.
list	select	resourceGroupName, circuitName, peeringName, subscriptionId		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
circuitName	string	The name of the circuit.
connectionName	string	The name of the peer express route circuit connection.
peeringName	string	The name of the peering.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

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

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.peer_express_route_circuit_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND circuitName = '{{ circuitName }}' -- required
AND peeringName = '{{ peeringName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

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

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.peer_express_route_circuit_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND circuitName = '{{ circuitName }}' -- required
AND peeringName = '{{ peeringName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;