express_route_connections

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

Overview

Name	express_route_connections
Type	Resource
Id	azure.network.express_route_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource. Required.
authorizationKey	string	Authorization key to establish the connection.
enableInternetSecurity	boolean	Enable internet security.
enablePrivateLinkFastPath	boolean	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
expressRouteCircuitPeering	object	The ExpressRoute circuit peering. Required.
expressRouteGatewayBypass	boolean	Enable FastPath to vWan Firewall hub.
provisioningState	string	The provisioning state of the express route connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingConfiguration	object	The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight	integer	The routing weight associated to the connection.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource. Required.
authorizationKey	string	Authorization key to establish the connection.
enableInternetSecurity	boolean	Enable internet security.
enablePrivateLinkFastPath	boolean	Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
expressRouteCircuitPeering	object	The ExpressRoute circuit peering. Required.
expressRouteGatewayBypass	boolean	Enable FastPath to vWan Firewall hub.
provisioningState	string	The provisioning state of the express route connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routingConfiguration	object	The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight	integer	The routing weight associated to the connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, express_route_gateway_name, connection_name, subscription_id		Gets the specified ExpressRouteConnection.
list	select	resource_group_name, express_route_gateway_name, subscription_id		Lists ExpressRouteConnections.
create_or_update	insert	resource_group_name, express_route_gateway_name, connection_name, subscription_id, name		Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.
create_or_update	replace	resource_group_name, express_route_gateway_name, connection_name, subscription_id, name		Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.
delete	delete	resource_group_name, express_route_gateway_name, connection_name, subscription_id		Deletes a connection to a ExpressRoute 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
connection_name	string	The name of the express route connection. Required.
express_route_gateway_name	string	The name of the express route gateway. 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 ExpressRouteConnection.

SELECT
id,
name,
authorizationKey,
enableInternetSecurity,
enablePrivateLinkFastPath,
expressRouteCircuitPeering,
expressRouteGatewayBypass,
provisioningState,
routingConfiguration,
routingWeight
FROM azure.network.express_route_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists ExpressRouteConnections.

SELECT
id,
name,
authorizationKey,
enableInternetSecurity,
enablePrivateLinkFastPath,
expressRouteCircuitPeering,
expressRouteGatewayBypass,
provisioningState,
routingConfiguration,
routingWeight
FROM azure.network.express_route_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.

INSERT INTO azure.network.express_route_connections (
id,
properties,
name,
resource_group_name,
express_route_gateway_name,
connection_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ properties }}',
'{{ name }}' /* required */,
'{{ resource_group_name }}',
'{{ express_route_gateway_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: express_route_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_connections resource.
  - name: express_route_gateway_name
    value: "{{ express_route_gateway_name }}"
    description: Required parameter for the express_route_connections resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the express_route_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_connections resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: properties
    description: |
      Properties of the express route connection.
    value:
      provisioningState: "{{ provisioningState }}"
      expressRouteCircuitPeering:
        id: "{{ id }}"
      authorizationKey: "{{ authorizationKey }}"
      routingWeight: {{ routingWeight }}
      enableInternetSecurity: {{ enableInternetSecurity }}
      expressRouteGatewayBypass: {{ expressRouteGatewayBypass }}
      enablePrivateLinkFastPath: {{ enablePrivateLinkFastPath }}
      routingConfiguration:
        associatedRouteTable:
          id: "{{ id }}"
        propagatedRouteTables:
          labels:
            - "{{ labels }}"
          ids:
            - id: "{{ id }}"
        vnetRoutes:
          staticRoutesConfig:
            propagateStaticRoutes: {{ propagateStaticRoutes }}
            vnetLocalRouteOverrideCriteria: "{{ vnetLocalRouteOverrideCriteria }}"
          staticRoutes:
            - name: "{{ name }}"
              addressPrefixes: "{{ addressPrefixes }}"
              nextHopIpAddress: "{{ nextHopIpAddress }}"
          bgpConnections:
            - id: "{{ id }}"
        inboundRouteMap:
          id: "{{ id }}"
        outboundRouteMap:
          id: "{{ id }}"
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resource. Required.

REPLACE examples

create_or_update

Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.

REPLACE azure.network.express_route_connections
SET 
id = '{{ id }}',
properties = '{{ properties }}',
name = '{{ name }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
properties;

DELETE examples

delete

Deletes a connection to a ExpressRoute circuit.

DELETE FROM azure.network.express_route_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND express_route_gateway_name = '{{ express_route_gateway_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;