express_route_cross_connections

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

Overview

Name	express_route_cross_connections
Type	Resource
Id	azure.network.express_route_cross_connections

Fields

The following fields are returned by SELECT queries:

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

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bandwidthInMbps	integer	The circuit bandwidth In Mbps.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuit	object	The ExpressRouteCircuit.
location	string	Resource location.
peeringLocation	string	The peering location of the ExpressRoute circuit.
peerings	array	The list of peerings.
primaryAzurePort	string	The name of the primary port.
provisioningState	string	The provisioning state of the express route cross connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sTag	integer	The identifier of the circuit traffic.
secondaryAzurePort	string	The name of the secondary port.
serviceProviderNotes	string	Additional read only notes set by the connectivity provider.
serviceProviderProvisioningState	string	The provisioning state of the circuit in the connectivity provider system. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning". (NotProvisioned, Provisioning, Provisioned, Deprovisioning)
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bandwidthInMbps	integer	The circuit bandwidth In Mbps.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuit	object	The ExpressRouteCircuit.
location	string	Resource location.
peeringLocation	string	The peering location of the ExpressRoute circuit.
peerings	array	The list of peerings.
primaryAzurePort	string	The name of the primary port.
provisioningState	string	The provisioning state of the express route cross connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sTag	integer	The identifier of the circuit traffic.
secondaryAzurePort	string	The name of the secondary port.
serviceProviderNotes	string	Additional read only notes set by the connectivity provider.
serviceProviderProvisioningState	string	The provisioning state of the circuit in the connectivity provider system. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning". (NotProvisioned, Provisioning, Provisioned, Deprovisioning)
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
bandwidthInMbps	integer	The circuit bandwidth In Mbps.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteCircuit	object	The ExpressRouteCircuit.
location	string	Resource location.
peeringLocation	string	The peering location of the ExpressRoute circuit.
peerings	array	The list of peerings.
primaryAzurePort	string	The name of the primary port.
provisioningState	string	The provisioning state of the express route cross connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
sTag	integer	The identifier of the circuit traffic.
secondaryAzurePort	string	The name of the secondary port.
serviceProviderNotes	string	Additional read only notes set by the connectivity provider.
serviceProviderProvisioningState	string	The provisioning state of the circuit in the connectivity provider system. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning". (NotProvisioned, Provisioning, Provisioned, Deprovisioning)
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
list_arp_table	select	resource_group_name, cross_connection_name, peering_name, device_path, subscription_id		Gets the currently advertised ARP table associated with the express route cross connection in a resource group.
get	select	resource_group_name, cross_connection_name, subscription_id		Gets details about the specified ExpressRouteCrossConnection.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieves all the ExpressRouteCrossConnections in a resource group.
list	select	subscription_id	$filter	Retrieves all the ExpressRouteCrossConnections in a subscription.
create_or_update	insert	resource_group_name, cross_connection_name, subscription_id		Update the specified ExpressRouteCrossConnection.
update_tags	update	resource_group_name, cross_connection_name, subscription_id		Updates an express route cross connection tags.
create_or_update	replace	resource_group_name, cross_connection_name, subscription_id		Update the specified ExpressRouteCrossConnection.
list_routes_table_summary	exec	resource_group_name, cross_connection_name, peering_name, device_path, subscription_id		Gets the route table summary associated with the express route cross connection in a resource group.
list_routes_table	exec	resource_group_name, cross_connection_name, peering_name, device_path, subscription_id		Gets the currently advertised routes table associated with the express route cross connection in a resource group.

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
cross_connection_name	string	The name of the ExpressRouteCrossConnection (service key of the circuit). Required.
device_path	string	The path of the device. 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
$filter	string	The filter to apply on the operation. For example, you can use $filter=name eq '{circuitServiceKey}'. Default value is None.

SELECT examples

list_arp_table

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

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

get

Gets details about the specified ExpressRouteCrossConnection.

SELECT
id,
name,
bandwidthInMbps,
etag,
expressRouteCircuit,
location,
peeringLocation,
peerings,
primaryAzurePort,
provisioningState,
sTag,
secondaryAzurePort,
serviceProviderNotes,
serviceProviderProvisioningState,
tags,
type
FROM azure.network.express_route_cross_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cross_connection_name = '{{ cross_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieves all the ExpressRouteCrossConnections in a resource group.

SELECT
id,
name,
bandwidthInMbps,
etag,
expressRouteCircuit,
location,
peeringLocation,
peerings,
primaryAzurePort,
provisioningState,
sTag,
secondaryAzurePort,
serviceProviderNotes,
serviceProviderProvisioningState,
tags,
type
FROM azure.network.express_route_cross_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves all the ExpressRouteCrossConnections in a subscription.

SELECT
id,
name,
bandwidthInMbps,
etag,
expressRouteCircuit,
location,
peeringLocation,
peerings,
primaryAzurePort,
provisioningState,
sTag,
secondaryAzurePort,
serviceProviderNotes,
serviceProviderProvisioningState,
tags,
type
FROM azure.network.express_route_cross_connections
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Update the specified ExpressRouteCrossConnection.

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

Manifest

# Description fields are for documentation purposes
- name: express_route_cross_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_cross_connections resource.
  - name: cross_connection_name
    value: "{{ cross_connection_name }}"
    description: Required parameter for the express_route_cross_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_cross_connections 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 cross connection.
    value:
      primaryAzurePort: "{{ primaryAzurePort }}"
      secondaryAzurePort: "{{ secondaryAzurePort }}"
      sTag: {{ sTag }}
      peeringLocation: "{{ peeringLocation }}"
      bandwidthInMbps: {{ bandwidthInMbps }}
      expressRouteCircuit:
        id: "{{ id }}"
      serviceProviderProvisioningState: "{{ serviceProviderProvisioningState }}"
      serviceProviderNotes: "{{ serviceProviderNotes }}"
      provisioningState: "{{ provisioningState }}"
      peerings:
        - id: "{{ id }}"
          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 }}"
            provisioningState: "{{ provisioningState }}"
            gatewayManagerEtag: "{{ gatewayManagerEtag }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            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 }}"
          name: "{{ name }}"
          etag: "{{ etag }}"

UPDATE examples

update_tags

Updates an express route cross connection tags.

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

REPLACE examples

create_or_update

Update the specified ExpressRouteCrossConnection.

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

Lifecycle Methods

list_routes_table_summary

Gets the route table summary associated with the express route cross connection in a resource group.

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

list_routes_table

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

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