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

Request successful. The operation returns the ExpressRouteConnection.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource.
properties	object	Properties of the express route connection.

list

Request successful.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource.
properties	object	Properties of the express route connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, expressRouteGatewayName, connectionName, subscriptionId		Gets the specified ExpressRouteConnection.
list	select	resourceGroupName, expressRouteGatewayName, subscriptionId		Lists ExpressRouteConnections.
create_or_update	insert	resourceGroupName, expressRouteGatewayName, connectionName, subscriptionId, data__name		Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.
delete	delete	resourceGroupName, expressRouteGatewayName, connectionName, subscriptionId		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
connectionName	string	The name of the connection subresource.
expressRouteGatewayName	string	The name of the ExpressRoute gateway.
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 ExpressRouteConnection.

SELECT
id,
name,
properties
FROM azure.network.express_route_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND expressRouteGatewayName = '{{ expressRouteGatewayName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists ExpressRouteConnections.

SELECT
id,
name,
properties
FROM azure.network.express_route_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND expressRouteGatewayName = '{{ expressRouteGatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.network.express_route_connections (
data__properties,
data__name,
data__id,
resourceGroupName,
expressRouteGatewayName,
connectionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}' /* required */,
'{{ id }}',
'{{ resourceGroupName }}',
'{{ expressRouteGatewayName }}',
'{{ connectionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: express_route_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the express_route_connections resource.
    - name: expressRouteGatewayName
      value: string
      description: Required parameter for the express_route_connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the express_route_connections resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the express_route_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the express route connection.
    - name: name
      value: string
      description: |
        The name of the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a connection to a ExpressRoute circuit.

DELETE FROM azure.network.express_route_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND expressRouteGatewayName = '{{ expressRouteGatewayName }}' --required
AND connectionName = '{{ connectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;