Azure ExpressRoute Peer Express Route Circuit Connections API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Peer Express Route Circuit…
  version: '2026-03-01'
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged PeerExpressRouteCircuitConnections across 2 of this provider''s published API definitions: microsoft-azure-express-route-expressroute-swagger.json, microsoft-azure-express-route-expressroute-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: PeerExpressRouteCircuitConnections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections
  : get:
      operationId: PeerExpressRouteCircuitConnections_List
      tags:
      - PeerExpressRouteCircuitConnections
      description: Gets all global reach peer connections associated with a private peering in an express route circuit.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: circuitName
        in: path
        description: The name of express route circuit.
        required: true
        schema:
          type: string
      - name: peeringName
        in: path
        description: The name of the peering.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeerExpressRouteCircuitConnectionListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List Peer ExpressRouteCircuit Connection:
          $ref: ./examples/PeerExpressRouteCircuitConnectionList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Peer express route circuit connections list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}
  : get:
      operationId: PeerExpressRouteCircuitConnections_Get
      tags:
      - PeerExpressRouteCircuitConnections
      description: Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: circuitName
        in: path
        description: The name of express route circuit.
        required: true
        schema:
          type: string
      - name: peeringName
        in: path
        description: The name of the peering.
        required: true
        schema:
          type: string
      - name: connectionName
        in: path
        description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeerExpressRouteCircuitConnection'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        PeerExpressRouteCircuitConnectionGet:
          $ref: ./examples/PeerExpressRouteCircuitConnectionGet.json
      summary: Peer express route circuit connections get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    PeerExpressRouteCircuitConnection:
      type: object
      description: Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.
      properties:
        properties:
          $ref: '#/components/schemas/PeerExpressRouteCircuitConnectionPropertiesFormat'
          description: Properties of the peer express route circuit connection.
          x-ms-client-flatten: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: ./common.json#/definitions/SubResourceModel
    PeerExpressRouteCircuitConnectionListResult:
      type: object
      description: The response of a PeerExpressRouteCircuitConnection list operation.
      properties:
        value:
          type: array
          description: The PeerExpressRouteCircuitConnection items on this page
          items:
            $ref: '#/components/schemas/PeerExpressRouteCircuitConnection'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    PeerExpressRouteCircuitConnectionPropertiesFormat:
      type: object
      description: Properties of the peer express route circuit connection.
      properties:
        expressRouteCircuitPeering:
          $ref: ./common.json#/definitions/SubResource
          description: Reference to Express Route Circuit Private Peering Resource of the circuit.
        peerExpressRouteCircuitPeering:
          $ref: ./common.json#/definitions/SubResource
          description: Reference to Express Route Circuit Private Peering Resource of the peered circuit.
        addressPrefix:
          type: string
          description: /29 IP address space to carve out Customer addresses for tunnels.
        circuitConnectionStatus:
          $ref: ./common.json#/definitions/CircuitConnectionStatus
          description: Express Route Circuit connection state.
          readOnly: true
        connectionName:
          type: string
          description: The name of the express route circuit connection resource.
        authResourceGuid:
          type: string
          description: The resource guid of the authorization used for the express route circuit connection.
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the peer express route circuit connection resource.
          readOnly: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-express-route-expressroute-swagger.json
- microsoft-azure-express-route-expressroute-openapi.json