express_route_ports

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

Overview

Name	express_route_ports
Type	Resource
Id	azure.network.express_route_ports

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allocationDate	string	Date of the physical port allocation to be used in Letter of Authorization.
bandwidthInGbps	integer	Bandwidth of procured ports in Gbps.
billingType	string	The billing type of the ExpressRoutePort resource. Known values are: "MeteredData" and "UnlimitedData". (MeteredData, UnlimitedData)
circuits	array	Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
encapsulation	string	Encapsulation method on physical ports. Known values are: "Dot1Q" and "QinQ". (Dot1Q, QinQ)
etag	string	A unique read-only string that changes whenever the resource is updated.
etherType	string	Ether type of the physical port.
identity	object	The identity of ExpressRoutePort, if configured.
links	array	ExpressRouteLink Sub-Resources.
location	string	Resource location.
mtu	string	Maximum transmission unit of the physical port pair(s).
peeringLocation	string	The name of the peering location that the ExpressRoutePort is mapped to physically.
provisionedBandwidthInGbps	number	Aggregate Gbps of associated circuit bandwidths.
provisioningState	string	The provisioning state of the express route port resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the express route port resource.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allocationDate	string	Date of the physical port allocation to be used in Letter of Authorization.
bandwidthInGbps	integer	Bandwidth of procured ports in Gbps.
billingType	string	The billing type of the ExpressRoutePort resource. Known values are: "MeteredData" and "UnlimitedData". (MeteredData, UnlimitedData)
circuits	array	Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
encapsulation	string	Encapsulation method on physical ports. Known values are: "Dot1Q" and "QinQ". (Dot1Q, QinQ)
etag	string	A unique read-only string that changes whenever the resource is updated.
etherType	string	Ether type of the physical port.
identity	object	The identity of ExpressRoutePort, if configured.
links	array	ExpressRouteLink Sub-Resources.
location	string	Resource location.
mtu	string	Maximum transmission unit of the physical port pair(s).
peeringLocation	string	The name of the peering location that the ExpressRoutePort is mapped to physically.
provisionedBandwidthInGbps	number	Aggregate Gbps of associated circuit bandwidths.
provisioningState	string	The provisioning state of the express route port resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the express route port resource.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allocationDate	string	Date of the physical port allocation to be used in Letter of Authorization.
bandwidthInGbps	integer	Bandwidth of procured ports in Gbps.
billingType	string	The billing type of the ExpressRoutePort resource. Known values are: "MeteredData" and "UnlimitedData". (MeteredData, UnlimitedData)
circuits	array	Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
encapsulation	string	Encapsulation method on physical ports. Known values are: "Dot1Q" and "QinQ". (Dot1Q, QinQ)
etag	string	A unique read-only string that changes whenever the resource is updated.
etherType	string	Ether type of the physical port.
identity	object	The identity of ExpressRoutePort, if configured.
links	array	ExpressRouteLink Sub-Resources.
location	string	Resource location.
mtu	string	Maximum transmission unit of the physical port pair(s).
peeringLocation	string	The name of the peering location that the ExpressRoutePort is mapped to physically.
provisionedBandwidthInGbps	number	Aggregate Gbps of associated circuit bandwidths.
provisioningState	string	The provisioning state of the express route port resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the express route port resource.
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	resource_group_name, express_route_port_name, subscription_id		Retrieves the requested ExpressRoutePort resource.
list_by_resource_group	select	resource_group_name, subscription_id		List all the ExpressRoutePort resources in the specified resource group.
list	select	subscription_id		List all the ExpressRoutePort resources in the specified subscription.
create_or_update	insert	resource_group_name, express_route_port_name, subscription_id		Creates or updates the specified ExpressRoutePort resource.
update_tags	update	resource_group_name, express_route_port_name, subscription_id		Update ExpressRoutePort tags.
create_or_update	replace	resource_group_name, express_route_port_name, subscription_id		Creates or updates the specified ExpressRoutePort resource.
delete	delete	resource_group_name, express_route_port_name, subscription_id		Deletes the specified ExpressRoutePort resource.
generate_loa	exec	resource_group_name, express_route_port_name, subscription_id, customerName		Generate a letter of authorization for the requested 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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves the requested ExpressRoutePort resource.

SELECT
id,
name,
allocationDate,
bandwidthInGbps,
billingType,
circuits,
encapsulation,
etag,
etherType,
identity,
links,
location,
mtu,
peeringLocation,
provisionedBandwidthInGbps,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.express_route_ports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND express_route_port_name = '{{ express_route_port_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all the ExpressRoutePort resources in the specified resource group.

SELECT
id,
name,
allocationDate,
bandwidthInGbps,
billingType,
circuits,
encapsulation,
etag,
etherType,
identity,
links,
location,
mtu,
peeringLocation,
provisionedBandwidthInGbps,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.express_route_ports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all the ExpressRoutePort resources in the specified subscription.

SELECT
id,
name,
allocationDate,
bandwidthInGbps,
billingType,
circuits,
encapsulation,
etag,
etherType,
identity,
links,
location,
mtu,
peeringLocation,
provisionedBandwidthInGbps,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.express_route_ports
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified ExpressRoutePort resource.

INSERT INTO azure.network.express_route_ports (
id,
location,
tags,
properties,
identity,
resource_group_name,
express_route_port_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ express_route_port_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_ports
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_ports resource.
  - name: express_route_port_name
    value: "{{ express_route_port_name }}"
    description: Required parameter for the express_route_ports resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_ports resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      ExpressRoutePort properties.
    value:
      peeringLocation: "{{ peeringLocation }}"
      bandwidthInGbps: {{ bandwidthInGbps }}
      provisionedBandwidthInGbps: {{ provisionedBandwidthInGbps }}
      mtu: "{{ mtu }}"
      encapsulation: "{{ encapsulation }}"
      etherType: "{{ etherType }}"
      allocationDate: "{{ allocationDate }}"
      links:
        - id: "{{ id }}"
          properties:
            routerName: "{{ routerName }}"
            interfaceName: "{{ interfaceName }}"
            patchPanelId: "{{ patchPanelId }}"
            rackId: "{{ rackId }}"
            coloLocation: "{{ coloLocation }}"
            connectorType: "{{ connectorType }}"
            adminState: "{{ adminState }}"
            provisioningState: "{{ provisioningState }}"
            macSecConfig:
              cknSecretIdentifier: "{{ cknSecretIdentifier }}"
              cakSecretIdentifier: "{{ cakSecretIdentifier }}"
              cipher: "{{ cipher }}"
              sciState: "{{ sciState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
      circuits:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"
      billingType: "{{ billingType }}"
  - name: identity
    description: |
      The identity of ExpressRoutePort, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update_tags

Update ExpressRoutePort tags.

UPDATE azure.network.express_route_ports
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND express_route_port_name = '{{ express_route_port_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates the specified ExpressRoutePort resource.

REPLACE azure.network.express_route_ports
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND express_route_port_name = '{{ express_route_port_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified ExpressRoutePort resource.

DELETE FROM azure.network.express_route_ports
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND express_route_port_name = '{{ express_route_port_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

generate_loa

Generate a letter of authorization for the requested ExpressRoutePort resource.

EXEC azure.network.express_route_ports.generate_loa 
@resource_group_name='{{ resource_group_name }}' --required, 
@express_route_port_name='{{ express_route_port_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"customerName": "{{ customerName }}"
}'
;