express_route_ports_locations

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

Overview

Name	express_route_ports_locations
Type	Resource
Id	azure.network.express_route_ports_locations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
address	string	Address of peering location.
availableBandwidths	array	The inventory of available ExpressRoutePort bandwidths.
contact	string	Contact details of peering locations.
location	string	Resource location.
provisioningState	string	The provisioning state of the express route port location resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
address	string	Address of peering location.
availableBandwidths	array	The inventory of available ExpressRoutePort bandwidths.
contact	string	Contact details of peering locations.
location	string	Resource location.
provisioningState	string	The provisioning state of the express route port location resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location_name, subscription_id		Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.
list	select	subscription_id		Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.

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
location_name	string	Name of the requested ExpressRoutePort peering location. Required.
subscription_id	string

SELECT examples

get

Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.

SELECT
id,
name,
address,
availableBandwidths,
contact,
location,
provisioningState,
tags,
type
FROM azure.network.express_route_ports_locations
WHERE location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.

SELECT
id,
name,
address,
availableBandwidths,
contact,
location,
provisioningState,
tags,
type
FROM azure.network.express_route_ports_locations
WHERE subscription_id = '{{ subscription_id }}' -- required
;