express_route_links

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

Overview

Name	express_route_links
Type	Resource
Id	azure.network.express_route_links

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of child port resource that is unique among child port resources of the parent.
adminState	string	Administrative state of the physical port. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
coloLocation	string	Cololocation for ExpressRoute Hybrid Direct.
connectorType	string	Physical fiber port type. Known values are: "LC" and "SC". (LC, SC)
etag	string	A unique read-only string that changes whenever the resource is updated.
interfaceName	string	Name of Azure router interface.
macSecConfig	object	MacSec configuration.
patchPanelId	string	Mapping between physical port to patch panel port.
provisioningState	string	The provisioning state of the express route link resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rackId	string	Mapping of physical patch panel to rack.
routerName	string	Name of Azure router associated with physical port.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of child port resource that is unique among child port resources of the parent.
adminState	string	Administrative state of the physical port. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
coloLocation	string	Cololocation for ExpressRoute Hybrid Direct.
connectorType	string	Physical fiber port type. Known values are: "LC" and "SC". (LC, SC)
etag	string	A unique read-only string that changes whenever the resource is updated.
interfaceName	string	Name of Azure router interface.
macSecConfig	object	MacSec configuration.
patchPanelId	string	Mapping between physical port to patch panel port.
provisioningState	string	The provisioning state of the express route link resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
rackId	string	Mapping of physical patch panel to rack.
routerName	string	Name of Azure router associated with physical port.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, express_route_port_name, link_name, subscription_id		Retrieves the specified ExpressRouteLink resource.
list	select	resource_group_name, express_route_port_name, subscription_id		Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.

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
express_route_port_name	string	The name of ExpressRoutePort. Required.
link_name	string	The name of the express route link. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves the specified ExpressRouteLink resource.

SELECT
id,
name,
adminState,
coloLocation,
connectorType,
etag,
interfaceName,
macSecConfig,
patchPanelId,
provisioningState,
rackId,
routerName
FROM azure.network.express_route_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_port_name = '{{ express_route_port_name }}' -- required
AND link_name = '{{ link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.

SELECT
id,
name,
adminState,
coloLocation,
connectorType,
etag,
interfaceName,
macSecConfig,
patchPanelId,
provisioningState,
rackId,
routerName
FROM azure.network.express_route_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_port_name = '{{ express_route_port_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;