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

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
azureASN	integer	The Azure ASN.
connections	array	The list of circuit connections associated with Azure Private Peering for this circuit.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteConnection	object	The ExpressRoute connection.
gatewayManagerEtag	string	The GatewayManager Etag.
ipv6PeeringConfig	object	The IPv6 peering configuration.
lastModifiedBy	string	Who was the last to modify the peering.
microsoftPeeringConfig	object	The Microsoft peering configuration.
peerASN	integer	The peer ASN.
peeredConnections	array	The list of peered circuit connections associated with Azure Private Peering for this circuit.
peeringType	string	The peering type. Known values are: "AzurePublicPeering", "AzurePrivatePeering", and "MicrosoftPeering". (AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering)
primaryAzurePort	string	The primary port.
primaryPeerAddressPrefix	string	The primary address prefix.
provisioningState	string	The provisioning state of the express route circuit peering resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routeFilter	object	Reference to another subresource.
secondaryAzurePort	string	The secondary port.
secondaryPeerAddressPrefix	string	The secondary address prefix.
sharedKey	string	The shared key.
state	string	The peering state. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
stats	object	The peering stats of express route circuit.
type	string	Resource type.
vlanId	integer	The VLAN ID.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
azureASN	integer	The Azure ASN.
connections	array	The list of circuit connections associated with Azure Private Peering for this circuit.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteConnection	object	The ExpressRoute connection.
gatewayManagerEtag	string	The GatewayManager Etag.
ipv6PeeringConfig	object	The IPv6 peering configuration.
lastModifiedBy	string	Who was the last to modify the peering.
microsoftPeeringConfig	object	The Microsoft peering configuration.
peerASN	integer	The peer ASN.
peeredConnections	array	The list of peered circuit connections associated with Azure Private Peering for this circuit.
peeringType	string	The peering type. Known values are: "AzurePublicPeering", "AzurePrivatePeering", and "MicrosoftPeering". (AzurePublicPeering, AzurePrivatePeering, MicrosoftPeering)
primaryAzurePort	string	The primary port.
primaryPeerAddressPrefix	string	The primary address prefix.
provisioningState	string	The provisioning state of the express route circuit peering resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
routeFilter	object	Reference to another subresource.
secondaryAzurePort	string	The secondary port.
secondaryPeerAddressPrefix	string	The secondary address prefix.
sharedKey	string	The shared key.
state	string	The peering state. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
stats	object	The peering stats of express route circuit.
type	string	Resource type.
vlanId	integer	The VLAN ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, circuit_name, peering_name, subscription_id		Gets the specified peering for the express route circuit.
list	select	resource_group_name, circuit_name, subscription_id		Gets all peerings in a specified express route circuit.
create_or_update	insert	resource_group_name, circuit_name, peering_name, subscription_id		Creates or updates a peering in the specified express route circuits.
create_or_update	replace	resource_group_name, circuit_name, peering_name, subscription_id		Creates or updates a peering in the specified express route circuits.
delete	delete	resource_group_name, circuit_name, peering_name, subscription_id		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
circuit_name	string	The name of express route circuit. 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

SELECT examples

get

Gets the specified peering for the express route circuit.

SELECT
id,
name,
azureASN,
connections,
etag,
expressRouteConnection,
gatewayManagerEtag,
ipv6PeeringConfig,
lastModifiedBy,
microsoftPeeringConfig,
peerASN,
peeredConnections,
peeringType,
primaryAzurePort,
primaryPeerAddressPrefix,
provisioningState,
routeFilter,
secondaryAzurePort,
secondaryPeerAddressPrefix,
sharedKey,
state,
stats,
type,
vlanId
FROM azure.network.express_route_circuit_peerings
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
;

list

Gets all peerings in a specified express route circuit.

SELECT
id,
name,
azureASN,
connections,
etag,
expressRouteConnection,
gatewayManagerEtag,
ipv6PeeringConfig,
lastModifiedBy,
microsoftPeeringConfig,
peerASN,
peeredConnections,
peeringType,
primaryAzurePort,
primaryPeerAddressPrefix,
provisioningState,
routeFilter,
secondaryAzurePort,
secondaryPeerAddressPrefix,
sharedKey,
state,
stats,
type,
vlanId
FROM azure.network.express_route_circuit_peerings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND circuit_name = '{{ circuit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
id,
name,
properties,
resource_group_name,
circuit_name,
peering_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ circuit_name }}',
'{{ peering_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: express_route_circuit_peerings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the express_route_circuit_peerings resource.
  - name: circuit_name
    value: "{{ circuit_name }}"
    description: Required parameter for the express_route_circuit_peerings resource.
  - name: peering_name
    value: "{{ peering_name }}"
    description: Required parameter for the express_route_circuit_peerings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the express_route_circuit_peerings resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the express route circuit peering.
    value:
      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:
            - prefix: "{{ prefix }}"
              validationId: "{{ validationId }}"
              signature: "{{ signature }}"
              validationState: "{{ validationState }}"
        routeFilter:
          id: "{{ id }}"
        state: "{{ state }}"
      expressRouteConnection:
        id: "{{ id }}"
      connections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            expressRouteCircuitPeering:
              id: "{{ id }}"
            peerExpressRouteCircuitPeering:
              id: "{{ id }}"
            addressPrefix: "{{ addressPrefix }}"
            authorizationKey: "{{ authorizationKey }}"
            ipv6CircuitConnectionConfig:
              addressPrefix: "{{ addressPrefix }}"
              circuitConnectionStatus: "{{ circuitConnectionStatus }}"
            circuitConnectionStatus: "{{ circuitConnectionStatus }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      peeredConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            expressRouteCircuitPeering:
              id: "{{ id }}"
            peerExpressRouteCircuitPeering:
              id: "{{ id }}"
            addressPrefix: "{{ addressPrefix }}"
            circuitConnectionStatus: "{{ circuitConnectionStatus }}"
            connectionName: "{{ connectionName }}"
            authResourceGuid: "{{ authResourceGuid }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"

REPLACE examples

create_or_update

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

REPLACE azure.network.express_route_circuit_peerings
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
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
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified peering from the specified express route circuit.

DELETE FROM azure.network.express_route_circuit_peerings
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
;