express_route_circuit_peerings

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

Overview

Name	express_route_circuit_peerings
Type	Resource
Id	azure.network.express_route_circuit_peerings

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting ExpressRouteCircuitPeering resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the express route circuit peering.
type	string	Type of the resource.

list

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

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the express route circuit peering.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, circuitName, peeringName, subscriptionId		Gets the specified peering for the express route circuit.
list	select	resourceGroupName, circuitName, subscriptionId		Gets all peerings in a specified express route circuit.
create_or_update	insert	resourceGroupName, circuitName, peeringName, subscriptionId		Creates or updates a peering in the specified express route circuits.
delete	delete	resourceGroupName, circuitName, peeringName, subscriptionId		Deletes the specified peering from the specified 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
circuitName	string	The name of the express route circuit.
peeringName	string	The name of the peering.
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 the specified peering for the express route circuit.

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

list

Gets all peerings in a specified express route circuit.

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

INSERT examples

create_or_update

Creates or updates a peering in the specified express route circuits.

INSERT INTO azure.network.express_route_circuit_peerings (
data__properties,
data__name,
data__id,
resourceGroupName,
circuitName,
peeringName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ circuitName }}',
'{{ peeringName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_circuit_peerings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the express_route_circuit_peerings resource.
    - name: circuitName
      value: string
      description: Required parameter for the express_route_circuit_peerings resource.
    - name: peeringName
      value: string
      description: Required parameter for the express_route_circuit_peerings resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the express_route_circuit_peerings resource.
    - name: properties
      value: object
      description: |
        Properties of the express route circuit peering.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified peering from the specified express route circuit.

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