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
- list
Request successful. The operation returns the requested ExpressRoutePort peering location.
| Name | Datatype | Description |
|---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
properties | object | ExpressRoutePort peering location properties. (title: ExpressRoutePorts Location Properties) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Request successful. The operation returns the list of all ExpressRoutePort peering locations.
| Name | Datatype | Description |
|---|---|---|
id | string (arm-id) | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name | string | The name of the resource |
properties | object | ExpressRoutePort peering location properties. (title: ExpressRoutePorts Location Properties) |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, locationName | Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location. | |
list | select | subscriptionId | 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 |
|---|---|---|
locationName | string | Name of the requested ExpressRoutePort peering location. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT examples
- get
- list
Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.network.express_route_ports_locations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND locationName = '{{ locationName }}' -- required
;
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,
properties,
systemData,
type
FROM azure.network.express_route_ports_locations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;