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:

get

Request successful. The operation returns the resulting ExpressRouteCrossConnection 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 cross connection.
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 ExpressRouteCrossConnection resources. If there are no cross connection resources 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.
properties	object	Properties of the express route cross connection.
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 ExpressRouteCrossConnection resources. If there are no cross connection resources 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.
properties	object	Properties of the express route cross connection.
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, crossConnectionName, subscriptionId		Gets details about the specified ExpressRouteCrossConnection.
list_by_resource_group	select	resourceGroupName, subscriptionId		Retrieves all the ExpressRouteCrossConnections in a resource group.
list	select	subscriptionId	$filter	Retrieves all the ExpressRouteCrossConnections in a subscription.
create_or_update	insert	resourceGroupName, crossConnectionName, subscriptionId		Update the specified ExpressRouteCrossConnection.
update_tags	exec	resourceGroupName, crossConnectionName, subscriptionId		Updates an express route cross connection 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
crossConnectionName	string	The name of the cross connection.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	The filter to apply on the operation. For example, you can use $filter=name eq '{circuitServiceKey}'.

SELECT examples

get

Gets details about the specified ExpressRouteCrossConnection.

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

list_by_resource_group

Retrieves all the ExpressRouteCrossConnections in a resource group.

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

list

Retrieves all the ExpressRouteCrossConnections in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.express_route_cross_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Update the specified ExpressRouteCrossConnection.

INSERT INTO azure.network.express_route_cross_connections (
data__properties,
resourceGroupName,
crossConnectionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ crossConnectionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_cross_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the express_route_cross_connections resource.
    - name: crossConnectionName
      value: string
      description: Required parameter for the express_route_cross_connections resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the express_route_cross_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the express route cross connection.

Lifecycle Methods

update_tags

Updates an express route cross connection tags.

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