express_route_circuit_peerings

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

Overview

Name	express_route_circuit_peerings
Type	Resource
Id	azure.network.express_route_circuit_peerings

Fields

vw_express_route_circuit_peerings

Name	Datatype	Description
id	text	Resource ID.
name	text	The name of the resource that is unique within a resource group. This name can be used to access the resource.
azure_asn	text	field from the properties object
circuitName	text	field from the properties object
connections	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
express_route_connection	text	field from the properties object
gateway_manager_etag	text	field from the properties object
ipv6_peering_config	text	field from the properties object
last_modified_by	text	field from the properties object
microsoft_peering_config	text	field from the properties object
peer_asn	text	field from the properties object
peered_connections	text	field from the properties object
peeringName	text	field from the properties object
peering_type	text	field from the properties object
primary_azure_port	text	field from the properties object
primary_peer_address_prefix	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
route_filter	text	field from the properties object
secondary_azure_port	text	field from the properties object
secondary_peer_address_prefix	text	field from the properties object
shared_key	text	field from the properties object
state	text	field from the properties object
stats	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Type of the resource.
vlan_id	text	field from the properties object

express_route_circuit_peerings

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

Name	Accessible by	Required Params	Description
get	SELECT	circuitName, peeringName, resourceGroupName, subscriptionId	Gets the specified peering for the express route circuit.
list	SELECT	circuitName, resourceGroupName, subscriptionId	Gets all peerings in a specified express route circuit.
create_or_update	INSERT	circuitName, peeringName, resourceGroupName, subscriptionId	Creates or updates a peering in the specified express route circuits.
delete	DELETE	circuitName, peeringName, resourceGroupName, subscriptionId	Deletes the specified peering from the specified express route circuit.

SELECT examples

Gets all peerings in a specified express route circuit.

vw_express_route_circuit_peerings

SELECT
id,
name,
azure_asn,
circuitName,
connections,
etag,
express_route_connection,
gateway_manager_etag,
ipv6_peering_config,
last_modified_by,
microsoft_peering_config,
peer_asn,
peered_connections,
peeringName,
peering_type,
primary_azure_port,
primary_peer_address_prefix,
provisioning_state,
resourceGroupName,
route_filter,
secondary_azure_port,
secondary_peer_address_prefix,
shared_key,
state,
stats,
subscriptionId,
type,
vlan_id
FROM azure.network.vw_express_route_circuit_peerings
WHERE circuitName = '{{ circuitName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

express_route_circuit_peerings

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

INSERT example

Use the following StackQL query and manifest file to create a new express_route_circuit_peerings resource.

All Properties

/*+ create */
INSERT INTO azure.network.express_route_circuit_peerings (
circuitName,
peeringName,
resourceGroupName,
subscriptionId,
properties,
name,
id
)
SELECT 
'{{ circuitName }}',
'{{ peeringName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ name }}',
'{{ id }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: peeringType
          value: []
        - name: state
          value: []
        - name: azureASN
          value: integer
        - name: peerASN
          value: integer
        - name: primaryPeerAddressPrefix
          value: string
        - name: secondaryPeerAddressPrefix
          value: string
        - name: primaryAzurePort
          value: string
        - name: secondaryAzurePort
          value: string
        - name: sharedKey
          value: string
        - name: vlanId
          value: integer
        - name: microsoftPeeringConfig
          value:
            - name: advertisedPublicPrefixes
              value:
                - string
            - name: advertisedCommunities
              value:
                - string
            - name: advertisedPublicPrefixesState
              value: string
            - name: legacyMode
              value: integer
            - name: customerASN
              value: integer
            - name: routingRegistryName
              value: string
        - name: stats
          value:
            - name: primarybytesIn
              value: integer
            - name: primarybytesOut
              value: integer
            - name: secondarybytesIn
              value: integer
            - name: secondarybytesOut
              value: integer
        - name: provisioningState
          value: []
        - name: gatewayManagerEtag
          value: string
        - name: lastModifiedBy
          value: string
        - name: routeFilter
          value:
            - name: id
              value: string
        - name: ipv6PeeringConfig
          value:
            - name: primaryPeerAddressPrefix
              value: string
            - name: secondaryPeerAddressPrefix
              value: string
            - name: state
              value: string
        - name: expressRouteConnection
          value:
            - name: id
              value: string
        - name: connections
          value:
            - - name: properties
                value:
                  - name: addressPrefix
                    value: string
                  - name: authorizationKey
                    value: string
                  - name: ipv6CircuitConnectionConfig
                    value:
                      - name: addressPrefix
                        value: string
                      - name: circuitConnectionStatus
                        value: []
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: peeredConnections
          value:
            - - name: properties
                value:
                  - name: addressPrefix
                    value: string
                  - name: connectionName
                    value: string
                  - name: authResourceGuid
                    value: string
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
    - name: name
      value: string
    - name: etag
      value: string
    - name: type
      value: string
    - name: id
      value: string

DELETE example

Deletes the specified express_route_circuit_peerings resource.

/*+ delete */
DELETE FROM azure.network.express_route_circuit_peerings
WHERE circuitName = '{{ circuitName }}'
AND peeringName = '{{ peeringName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';