express_route_circuit_connections

Creates, updates, deletes, gets or lists an express_route_circuit_connections resource.

Overview

Name	express_route_circuit_connections
Type	Resource
Id	azure.network.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.
authorizationKey	string	The authorization key.
circuitConnectionStatus	string	Express Route Circuit connection state. Known values are: "Connected", "Connecting", and "Disconnected". (Connected, Connecting, Disconnected)
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuitPeering	object	Reference to another subresource.
ipv6CircuitConnectionConfig	object	IPv6 Address PrefixProperties of the express route circuit connection.
peerExpressRouteCircuitPeering	object	Reference to another subresource.
provisioningState	string	The provisioning state of the 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.
authorizationKey	string	The authorization key.
circuitConnectionStatus	string	Express Route Circuit connection state. Known values are: "Connected", "Connecting", and "Disconnected". (Connected, Connecting, Disconnected)
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuitPeering	object	Reference to another subresource.
ipv6CircuitConnectionConfig	object	IPv6 Address PrefixProperties of the express route circuit connection.
peerExpressRouteCircuitPeering	object	Reference to another subresource.
provisioningState	string	The provisioning state of the 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 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 connections associated with a private peering in an express route circuit.
create_or_update	insert	resource_group_name, circuit_name, peering_name, connection_name, subscription_id		Creates or updates a Express Route Circuit Connection in the specified express route circuits.
create_or_update	replace	resource_group_name, circuit_name, peering_name, connection_name, subscription_id		Creates or updates a Express Route Circuit Connection in the specified express route circuits.
delete	delete	resource_group_name, circuit_name, peering_name, connection_name, subscription_id		Deletes the specified Express Route Circuit Connection from the specified 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 express route circuit connection. 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 Express Route Circuit Connection from the specified express route circuit.

SELECT
id,
name,
addressPrefix,
authorizationKey,
circuitConnectionStatus,
etag,
expressRouteCircuitPeering,
ipv6CircuitConnectionConfig,
peerExpressRouteCircuitPeering,
provisioningState,
type
FROM azure.network.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 connections associated with a private peering in an express route circuit.

SELECT
id,
name,
addressPrefix,
authorizationKey,
circuitConnectionStatus,
etag,
expressRouteCircuitPeering,
ipv6CircuitConnectionConfig,
peerExpressRouteCircuitPeering,
provisioningState,
type
FROM azure.network.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
;

INSERT examples

create_or_update

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

INSERT INTO azure.network.express_route_circuit_connections (
id,
name,
properties,
resource_group_name,
circuit_name,
peering_name,
connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ circuit_name }}',
'{{ peering_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_circuit_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_circuit_connections resource.
  - name: circuit_name
    value: "{{ circuit_name }}"
    description: Required parameter for the express_route_circuit_connections resource.
  - name: peering_name
    value: "{{ peering_name }}"
    description: Required parameter for the express_route_circuit_connections resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the express_route_circuit_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_circuit_connections resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the express route circuit connection.
    value:
      expressRouteCircuitPeering:
        id: "{{ id }}"
      peerExpressRouteCircuitPeering:
        id: "{{ id }}"
      addressPrefix: "{{ addressPrefix }}"
      authorizationKey: "{{ authorizationKey }}"
      ipv6CircuitConnectionConfig:
        addressPrefix: "{{ addressPrefix }}"
        circuitConnectionStatus: "{{ circuitConnectionStatus }}"
      circuitConnectionStatus: "{{ circuitConnectionStatus }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

REPLACE azure.network.express_route_circuit_connections
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
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
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

DELETE FROM azure.network.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
;