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

Request successful. The operation returns the requested ExpressRouteLink resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of child port resource that is unique among child port resources of the parent.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	ExpressRouteLink properties. (title: ExpressRouteLink Resource Properties)

list

Request successful. The operation returns a list of ExpressRouteLink resources. If there are no ExpressRouteLink resources then an empty list is returned.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of child port resource that is unique among child port resources of the parent.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	ExpressRouteLink properties. (title: ExpressRouteLink Resource Properties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, expressRoutePortName, linkName		Retrieves the specified ExpressRouteLink resource.
list	select	subscriptionId, resourceGroupName, expressRoutePortName		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
expressRoutePortName	string	The name of the ExpressRoutePort resource.
linkName	string	The name of the ExpressRouteLink resource.
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

Retrieves the specified ExpressRouteLink resource.

SELECT
id,
name,
etag,
properties
FROM azure.network.express_route_links
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND expressRoutePortName = '{{ expressRoutePortName }}' -- required
AND linkName = '{{ linkName }}' -- required
;

list

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

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