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_circuit_link_failover_single_test_details

Name	Datatype	Description
bgpStatus	array	The BGP status details.
circuitTestCategory	string	The circuit test category. Known values are: "BgpDisconnect" and "ASPathPrepend". (BgpDisconnect, ASPathPrepend)
endTimeUtc	string	Time when the test was completed in UTC.
isSimulationVerified	boolean	Whether the simulation was verified.
linkType	string	The link type. Known values are: "Primary" and "Secondary". (Primary, Secondary)
nonRedundantRoutes	object	The non-redundant routes for link failover tests.
redundantRoutes	object	The redundant routes for link failover tests.
startTimeUtc	string	Time when the test was started in UTC.
status	string	The current status of the test. Known values are: "NotStarted", "Starting", "Running", "StartFailed", "Stopping", "Completed", "StopFailed", "Invalid", and "Expired". (NotStarted, Starting, Running, StartFailed, Stopping, Completed, StopFailed, Invalid, Expired)
wasSimulationSuccessful	boolean	Whether the failover simulation was successful or not.

list_arp_table

Name	Datatype	Description
age	integer	Entry age in minutes.
interface	string	Interface address.
ipAddress	string	The IP address.
macAddress	string	The MAC address.

get_peering_stats

Name	Datatype	Description
primarybytesIn	integer	The Primary BytesIn of the peering.
primarybytesOut	integer	The primary BytesOut of the peering.
secondarybytesIn	integer	The secondary BytesIn of the peering.
secondarybytesOut	integer	The secondary BytesOut of the peering.

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowClassicOperations	boolean	Allow classic operations.
authorizationKey	string	The authorizationKey.
authorizationStatus	string	The authorization status of the Circuit.
authorizations	array	The list of authorizations.
bandwidthInGbps	number	The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
circuitProvisioningState	string	The CircuitProvisioningState state of the resource.
enableDirectPortRateLimit	boolean	Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRoutePort	object	Reference to another subresource.
gatewayManagerEtag	string	The GatewayManager Etag.
globalReachEnabled	boolean	Flag denoting global reach status.
location	string	Resource location.
peerings	array	The list of peerings.
provisioningState	string	The provisioning state of the express route circuit resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
serviceKey	string	The ServiceKey.
serviceProviderNotes	string	The ServiceProviderNotes.
serviceProviderProperties	object	The ServiceProviderProperties.
serviceProviderProvisioningState	string	The ServiceProviderProvisioningState state of the resource. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning". (NotProvisioned, Provisioning, Provisioned, Deprovisioning)
sku	object	The SKU.
stag	integer	The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowClassicOperations	boolean	Allow classic operations.
authorizationKey	string	The authorizationKey.
authorizationStatus	string	The authorization status of the Circuit.
authorizations	array	The list of authorizations.
bandwidthInGbps	number	The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
circuitProvisioningState	string	The CircuitProvisioningState state of the resource.
enableDirectPortRateLimit	boolean	Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRoutePort	object	Reference to another subresource.
gatewayManagerEtag	string	The GatewayManager Etag.
globalReachEnabled	boolean	Flag denoting global reach status.
location	string	Resource location.
peerings	array	The list of peerings.
provisioningState	string	The provisioning state of the express route circuit resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
serviceKey	string	The ServiceKey.
serviceProviderNotes	string	The ServiceProviderNotes.
serviceProviderProperties	object	The ServiceProviderProperties.
serviceProviderProvisioningState	string	The ServiceProviderProvisioningState state of the resource. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning". (NotProvisioned, Provisioning, Provisioned, Deprovisioning)
sku	object	The SKU.
stag	integer	The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
tags	object	Resource tags.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowClassicOperations	boolean	Allow classic operations.
authorizationKey	string	The authorizationKey.
authorizationStatus	string	The authorization status of the Circuit.
authorizations	array	The list of authorizations.
bandwidthInGbps	number	The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
circuitProvisioningState	string	The CircuitProvisioningState state of the resource.
enableDirectPortRateLimit	boolean	Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRoutePort	object	Reference to another subresource.
gatewayManagerEtag	string	The GatewayManager Etag.
globalReachEnabled	boolean	Flag denoting global reach status.
location	string	Resource location.
peerings	array	The list of peerings.
provisioningState	string	The provisioning state of the express route circuit resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
serviceKey	string	The ServiceKey.
serviceProviderNotes	string	The ServiceProviderNotes.
serviceProviderProperties	object	The ServiceProviderProperties.
serviceProviderProvisioningState	string	The ServiceProviderProvisioningState state of the resource. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning". (NotProvisioned, Provisioning, Provisioned, Deprovisioning)
sku	object	The SKU.
stag	integer	The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
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_circuit_link_failover_single_test_details	select	resource_group_name, circuit_name, subscription_id, linkType, circuitTestCategory, failoverTestId		Retrieves the details of a particular link failover test performed on the express route circuit.
list_arp_table	select	resource_group_name, circuit_name, peering_name, device_path, subscription_id		Gets the currently advertised ARP table associated with the express route circuit in a resource group.
get_peering_stats	select	resource_group_name, circuit_name, peering_name, subscription_id		Gets all stats from an express route circuit in a resource group.
get	select	resource_group_name, circuit_name, subscription_id		Gets information about the specified express route circuit.
list	select	resource_group_name, subscription_id		Gets all the express route circuits in a resource group.
list_all	select	subscription_id		Gets all the express route circuits in a subscription.
create_or_update	insert	resource_group_name, circuit_name, subscription_id		Creates or updates an express route circuit.
update_tags	update	resource_group_name, circuit_name, subscription_id		Updates an express route circuit tags.
create_or_update	replace	resource_group_name, circuit_name, subscription_id		Creates or updates an express route circuit.
delete	delete	resource_group_name, circuit_name, subscription_id		Deletes the specified express route circuit.
list_routes_table	exec	resource_group_name, circuit_name, peering_name, device_path, subscription_id		Gets the currently advertised routes table associated with the express route circuit in a resource group.
list_routes_table_summary	exec	resource_group_name, circuit_name, peering_name, device_path, subscription_id		Gets the currently advertised routes table summary associated with the express route circuit in a resource group.
get_stats	exec	resource_group_name, circuit_name, subscription_id		Gets all the stats from an express route circuit in a resource group.
get_circuit_link_failover_all_tests_details	exec	resource_group_name, circuit_name, subscription_id	failoverTestType, fetchLatest	Retrieves the details of all the link failover tests performed on the express route circuit.
start_circuit_link_failover_test	exec	resource_group_name, circuit_name, subscription_id, linkType, circuitTestCategory		Starts link failover simulation on the express route circuit for the specified link type and test category.
stop_circuit_link_failover_test	exec	resource_group_name, circuit_name, subscription_id		Stops link failover simulation on the express route circuit.

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
circuitTestCategory	string	The circuit test category. Required.
circuit_name	string	The name of express route circuit. Required.
device_path	string	The name of the routeTablesSummary. Required.
failoverTestId	string	The unique Guid value which identifies the test. Required.
linkType	string	The link type. Required.
peering_name	string	The name of the peering. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
failoverTestType	string	The type of failover test. Default value is None.
fetchLatest	boolean	Fetch only the latest tests. Default value is None.

SELECT examples

get_circuit_link_failover_single_test_details

Retrieves the details of a particular link failover test performed on the express route circuit.

SELECT
bgpStatus,
circuitTestCategory,
endTimeUtc,
isSimulationVerified,
linkType,
nonRedundantRoutes,
redundantRoutes,
startTimeUtc,
status,
wasSimulationSuccessful
FROM azure.network.express_route_circuits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND linkType = '{{ linkType }}' -- required
AND circuitTestCategory = '{{ circuitTestCategory }}' -- required
AND failoverTestId = '{{ failoverTestId }}' -- required
;

list_arp_table

Gets the currently advertised ARP table associated with the express route circuit in a resource group.

SELECT
age,
interface,
ipAddress,
macAddress
FROM azure.network.express_route_circuits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND device_path = '{{ device_path }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_peering_stats

Gets all stats from an express route circuit in a resource group.

SELECT
primarybytesIn,
primarybytesOut,
secondarybytesIn,
secondarybytesOut
FROM azure.network.express_route_circuits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets information about the specified express route circuit.

SELECT
id,
name,
allowClassicOperations,
authorizationKey,
authorizationStatus,
authorizations,
bandwidthInGbps,
circuitProvisioningState,
enableDirectPortRateLimit,
etag,
expressRoutePort,
gatewayManagerEtag,
globalReachEnabled,
location,
peerings,
provisioningState,
serviceKey,
serviceProviderNotes,
serviceProviderProperties,
serviceProviderProvisioningState,
sku,
stag,
tags,
type
FROM azure.network.express_route_circuits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the express route circuits in a resource group.

SELECT
id,
name,
allowClassicOperations,
authorizationKey,
authorizationStatus,
authorizations,
bandwidthInGbps,
circuitProvisioningState,
enableDirectPortRateLimit,
etag,
expressRoutePort,
gatewayManagerEtag,
globalReachEnabled,
location,
peerings,
provisioningState,
serviceKey,
serviceProviderNotes,
serviceProviderProperties,
serviceProviderProvisioningState,
sku,
stag,
tags,
type
FROM azure.network.express_route_circuits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the express route circuits in a subscription.

SELECT
id,
name,
allowClassicOperations,
authorizationKey,
authorizationStatus,
authorizations,
bandwidthInGbps,
circuitProvisioningState,
enableDirectPortRateLimit,
etag,
expressRoutePort,
gatewayManagerEtag,
globalReachEnabled,
location,
peerings,
provisioningState,
serviceKey,
serviceProviderNotes,
serviceProviderProperties,
serviceProviderProvisioningState,
sku,
stag,
tags,
type
FROM azure.network.express_route_circuits
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an express route circuit.

INSERT INTO azure.network.express_route_circuits (
id,
location,
tags,
properties,
sku,
resource_group_name,
circuit_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ circuit_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_circuits
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_circuits resource.
  - name: circuit_name
    value: "{{ circuit_name }}"
    description: Required parameter for the express_route_circuits resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_circuits 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: |
      Properties of the express route circuit.
    value:
      allowClassicOperations: {{ allowClassicOperations }}
      circuitProvisioningState: "{{ circuitProvisioningState }}"
      serviceProviderProvisioningState: "{{ serviceProviderProvisioningState }}"
      authorizations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            authorizationKey: "{{ authorizationKey }}"
            authorizationUseStatus: "{{ authorizationUseStatus }}"
            connectionResourceUri: "{{ connectionResourceUri }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      peerings:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            peeringType: "{{ peeringType }}"
            state: "{{ state }}"
            azureASN: {{ azureASN }}
            peerASN: {{ peerASN }}
            primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
            secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
            primaryAzurePort: "{{ primaryAzurePort }}"
            secondaryAzurePort: "{{ secondaryAzurePort }}"
            sharedKey: "{{ sharedKey }}"
            vlanId: {{ vlanId }}
            microsoftPeeringConfig:
              advertisedPublicPrefixes:
                - "{{ advertisedPublicPrefixes }}"
              advertisedCommunities:
                - "{{ advertisedCommunities }}"
              advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
              legacyMode: {{ legacyMode }}
              customerASN: {{ customerASN }}
              routingRegistryName: "{{ routingRegistryName }}"
              advertisedPublicPrefixInfo:
                - prefix: "{{ prefix }}"
                  validationId: "{{ validationId }}"
                  signature: "{{ signature }}"
                  validationState: "{{ validationState }}"
            stats:
              primarybytesIn: {{ primarybytesIn }}
              primarybytesOut: {{ primarybytesOut }}
              secondarybytesIn: {{ secondarybytesIn }}
              secondarybytesOut: {{ secondarybytesOut }}
            provisioningState: "{{ provisioningState }}"
            gatewayManagerEtag: "{{ gatewayManagerEtag }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            routeFilter:
              id: "{{ id }}"
            ipv6PeeringConfig:
              primaryPeerAddressPrefix: "{{ primaryPeerAddressPrefix }}"
              secondaryPeerAddressPrefix: "{{ secondaryPeerAddressPrefix }}"
              microsoftPeeringConfig:
                advertisedPublicPrefixes: "{{ advertisedPublicPrefixes }}"
                advertisedCommunities: "{{ advertisedCommunities }}"
                advertisedPublicPrefixesState: "{{ advertisedPublicPrefixesState }}"
                legacyMode: {{ legacyMode }}
                customerASN: {{ customerASN }}
                routingRegistryName: "{{ routingRegistryName }}"
                advertisedPublicPrefixInfo: "{{ advertisedPublicPrefixInfo }}"
              routeFilter:
                id: "{{ id }}"
              state: "{{ state }}"
            expressRouteConnection:
              id: "{{ id }}"
            connections:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  expressRouteCircuitPeering: "{{ expressRouteCircuitPeering }}"
                  peerExpressRouteCircuitPeering: "{{ peerExpressRouteCircuitPeering }}"
                  addressPrefix: "{{ addressPrefix }}"
                  authorizationKey: "{{ authorizationKey }}"
                  ipv6CircuitConnectionConfig: "{{ ipv6CircuitConnectionConfig }}"
                  circuitConnectionStatus: "{{ circuitConnectionStatus }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            peeredConnections:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  expressRouteCircuitPeering: "{{ expressRouteCircuitPeering }}"
                  peerExpressRouteCircuitPeering: "{{ peerExpressRouteCircuitPeering }}"
                  addressPrefix: "{{ addressPrefix }}"
                  circuitConnectionStatus: "{{ circuitConnectionStatus }}"
                  connectionName: "{{ connectionName }}"
                  authResourceGuid: "{{ authResourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
          etag: "{{ etag }}"
      serviceKey: "{{ serviceKey }}"
      serviceProviderNotes: "{{ serviceProviderNotes }}"
      serviceProviderProperties:
        serviceProviderName: "{{ serviceProviderName }}"
        peeringLocation: "{{ peeringLocation }}"
        bandwidthInMbps: {{ bandwidthInMbps }}
      expressRoutePort:
        id: "{{ id }}"
      bandwidthInGbps: {{ bandwidthInGbps }}
      stag: {{ stag }}
      provisioningState: "{{ provisioningState }}"
      gatewayManagerEtag: "{{ gatewayManagerEtag }}"
      globalReachEnabled: {{ globalReachEnabled }}
      authorizationKey: "{{ authorizationKey }}"
      authorizationStatus: "{{ authorizationStatus }}"
      enableDirectPortRateLimit: {{ enableDirectPortRateLimit }}
  - name: sku
    description: |
      The SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      family: "{{ family }}"

UPDATE examples

update_tags

Updates an express route circuit tags.

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

REPLACE examples

create_or_update

Creates or updates an express route circuit.

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

DELETE examples

delete

Deletes the specified express route circuit.

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

Lifecycle Methods

list_routes_table

Gets the currently advertised routes table associated with the express route circuit in a resource group.

EXEC azure.network.express_route_circuits.list_routes_table 
@resource_group_name='{{ resource_group_name }}' --required, 
@circuit_name='{{ circuit_name }}' --required, 
@peering_name='{{ peering_name }}' --required, 
@device_path='{{ device_path }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_routes_table_summary

Gets the currently advertised routes table summary associated with the express route circuit in a resource group.

EXEC azure.network.express_route_circuits.list_routes_table_summary 
@resource_group_name='{{ resource_group_name }}' --required, 
@circuit_name='{{ circuit_name }}' --required, 
@peering_name='{{ peering_name }}' --required, 
@device_path='{{ device_path }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_stats

Gets all the stats from an express route circuit in a resource group.

EXEC azure.network.express_route_circuits.get_stats 
@resource_group_name='{{ resource_group_name }}' --required, 
@circuit_name='{{ circuit_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_circuit_link_failover_all_tests_details

Retrieves the details of all the link failover tests performed on the express route circuit.

EXEC azure.network.express_route_circuits.get_circuit_link_failover_all_tests_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@circuit_name='{{ circuit_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@failoverTestType='{{ failoverTestType }}', 
@fetchLatest={{ fetchLatest }}
;

start_circuit_link_failover_test

Starts link failover simulation on the express route circuit for the specified link type and test category.

EXEC azure.network.express_route_circuits.start_circuit_link_failover_test 
@resource_group_name='{{ resource_group_name }}' --required, 
@circuit_name='{{ circuit_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@linkType='{{ linkType }}' --required, 
@circuitTestCategory='{{ circuitTestCategory }}' --required
;

stop_circuit_link_failover_test

Stops link failover simulation on the express route circuit.

EXEC azure.network.express_route_circuits.stop_circuit_link_failover_test 
@resource_group_name='{{ resource_group_name }}' --required, 
@circuit_name='{{ circuit_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"circuitTestCategory": "{{ circuitTestCategory }}", 
"linkType": "{{ linkType }}", 
"wasSimulationSuccessful": {{ wasSimulationSuccessful }}, 
"isVerified": {{ isVerified }}
}'
;