express_route_circuits

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

Overview

Name	express_route_circuits
Type	Resource
Id	azure.network.express_route_circuits

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting ExpressRouteCircuit 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.
properties	object	Properties of the express route circuit.
sku	object	The SKU.
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 the resulting ExpressRouteCircuitAuthorization 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.
properties	object	Properties of the express route circuit.
sku	object	The SKU.
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_all

Request successful. The operation returns a list of ExpressRouteCircuit resources.

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.
properties	object	Properties of the express route circuit.
sku	object	The SKU.
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	resourceGroupName, circuitName, subscriptionId		Gets information about the specified express route circuit.
list	select	resourceGroupName, subscriptionId		Gets all the express route circuits in a resource group.
list_all	select	subscriptionId		Gets all the express route circuits in a subscription.
create_or_update	insert	resourceGroupName, circuitName, subscriptionId		Creates or updates an express route circuit.
delete	delete	resourceGroupName, circuitName, subscriptionId		Deletes the specified express route circuit.
update_tags	exec	resourceGroupName, circuitName, subscriptionId		Updates an express route circuit tags.

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
circuitName	string	The name of the circuit.
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

Gets information about the specified express route circuit.

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

list

Gets all the express route circuits in a resource group.

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

list_all

Gets all the express route circuits in a subscription.

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

INSERT examples

create_or_update

Creates or updates an express route circuit.

INSERT INTO azure.network.express_route_circuits (
data__sku,
data__properties,
resourceGroupName,
circuitName,
subscriptionId
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ circuitName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_circuits
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the express_route_circuits resource.
    - name: circuitName
      value: string
      description: Required parameter for the express_route_circuits resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the express_route_circuits resource.
    - name: sku
      value: object
      description: |
        The SKU.
    - name: properties
      value: object
      description: |
        Properties of the express route circuit.

DELETE examples

delete

Deletes the specified express route circuit.

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

Lifecycle Methods

update_tags

Updates an express route circuit tags.

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