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

Request successful. The operation returns the requested ExpressRoutePort resource.

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
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of ExpressRoutePort, if configured.
properties	object	ExpressRoutePort properties. (title: ExpressRoutePort 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"

list_by_resource_group

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

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
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of ExpressRoutePort, if configured.
properties	object	ExpressRoutePort properties. (title: ExpressRoutePort 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"

list

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

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
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The identity of ExpressRoutePort, if configured.
properties	object	ExpressRoutePort properties. (title: ExpressRoutePort 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, resourceGroupName, expressRoutePortName		Retrieves the requested ExpressRoutePort resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the ExpressRoutePort resources in the specified resource group.
list	select	subscriptionId		List all the ExpressRoutePort resources in the specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, expressRoutePortName		Creates or updates the specified ExpressRoutePort resource.
delete	delete	subscriptionId, resourceGroupName, expressRoutePortName		Deletes the specified ExpressRoutePort resource.
update_tags	exec	subscriptionId, resourceGroupName, expressRoutePortName		Update ExpressRoutePort tags.
generate_loa	exec	subscriptionId, resourceGroupName, expressRoutePortName, 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
expressRoutePortName	string	The name of ExpressRoutePort.
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 requested ExpressRoutePort resource.

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

list_by_resource_group

List all the ExpressRoutePort resources in the specified resource group.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type
FROM azure.network.express_route_ports
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

List all the ExpressRoutePort resources in the specified subscription.

SELECT
id,
name,
etag,
identity,
properties,
systemData,
type
FROM azure.network.express_route_ports
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified ExpressRoutePort resource.

INSERT INTO azure.network.express_route_ports (
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
expressRoutePortName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ expressRoutePortName }}'
RETURNING
id,
name,
etag,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_ports
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the express_route_ports resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the express_route_ports resource.
    - name: expressRoutePortName
      value: string
      description: Required parameter for the express_route_ports resource.
    - name: properties
      value: object
      description: |
        ExpressRoutePort properties.
    - name: identity
      value: object
      description: |
        The identity of ExpressRoutePort, if configured.

DELETE examples

delete

Deletes the specified ExpressRoutePort resource.

DELETE FROM azure.network.express_route_ports
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND expressRoutePortName = '{{ expressRoutePortName }}' --required
;

Lifecycle Methods

update_tags

Update ExpressRoutePort tags.

EXEC azure.network.express_route_ports.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@expressRoutePortName='{{ expressRoutePortName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

generate_loa

Generate a letter of authorization for the requested ExpressRoutePort resource.

EXEC azure.network.express_route_ports.generate_loa 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@expressRoutePortName='{{ expressRoutePortName }}' --required 
@@json=
'{
"customerName": "{{ customerName }}"
}'
;