Azure ExpressRoute Express Route Circuit Peerings API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route 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 ExpressRouteCircuitPeerings 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: ExpressRouteCircuitPeerings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings
  : get:
      operationId: ExpressRouteCircuitPeerings_List
      tags:
      - ExpressRouteCircuitPeerings
      description: Gets all peerings in a 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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeeringListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List ExpressRouteCircuit Peerings:
          $ref: ./examples/ExpressRouteCircuitPeeringList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route circuit peerings list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}
  : get:
      operationId: ExpressRouteCircuitPeerings_Get
      tags:
      - ExpressRouteCircuitPeerings
      description: Gets the specified peering for the 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/ExpressRouteCircuitPeering'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Get ExpressRouteCircuit Peering:
          $ref: ./examples/ExpressRouteCircuitPeeringGet.json
      summary: Express route circuit peerings get
      x-summary-source: derived
    put:
      operationId: ExpressRouteCircuitPeerings_CreateOrUpdate
      tags:
      - ExpressRouteCircuitPeerings
      description: Creates or updates a peering in the specified express route circuits.
      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: Resource 'ExpressRouteCircuitPeering' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
        '201':
          description: Resource 'ExpressRouteCircuitPeering' create operation succeeded
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCircuitPeering'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Create ExpressRouteCircuit Peerings:
          $ref: ./examples/ExpressRouteCircuitPeeringCreate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/ExpressRouteCircuitPeering'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRouteCircuitPeering'
        description: Parameters supplied to the create or update express route circuit peering operation.
        required: true
      summary: Express route circuit peerings create or update
      x-summary-source: derived
    delete:
      operationId: ExpressRouteCircuitPeerings_Delete
      tags:
      - ExpressRouteCircuitPeerings
      description: Deletes the specified peering 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
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Delete ExpressRouteCircuit Peerings:
          $ref: ./examples/ExpressRouteCircuitPeeringDelete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Express route circuit peerings delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    Ipv6ExpressRouteCircuitPeeringConfig:
      type: object
      description: Contains IPv6 peering config.
      properties:
        primaryPeerAddressPrefix:
          type: string
          description: The primary address prefix.
        secondaryPeerAddressPrefix:
          type: string
          description: The secondary address prefix.
        microsoftPeeringConfig:
          $ref: '#/components/schemas/ExpressRouteCircuitPeeringConfig'
          description: The Microsoft peering configuration.
        routeFilter:
          $ref: ./common.json#/definitions/SubResource
          description: The reference to the RouteFilter resource.
        state:
          $ref: ./common.json#/definitions/ExpressRouteCircuitPeeringState
          description: The state of peering.
    ExpressRouteCircuitPeeringPropertiesFormat:
      type: object
      description: Properties of the express route circuit peering.
      properties:
        peeringType:
          $ref: ./common.json#/definitions/ExpressRoutePeeringType
          description: The peering type.
        state:
          $ref: ./common.json#/definitions/ExpressRoutePeeringState
          description: The peering state.
        azureASN:
          type: integer
          format: int32
          description: The Azure ASN.
        peerASN:
          type: integer
          format: int64
          description: The peer ASN.
          minimum: 1
          maximum: 4294967295
        primaryPeerAddressPrefix:
          type: string
          description: The primary address prefix.
        secondaryPeerAddressPrefix:
          type: string
          description: The secondary address prefix.
        primaryAzurePort:
          type: string
          description: The primary port.
        secondaryAzurePort:
          type: string
          description: The secondary port.
        sharedKey:
          type: string
          description: The shared key.
        vlanId:
          type: integer
          format: int32
          description: The VLAN ID.
        microsoftPeeringConfig:
          $ref: '#/components/schemas/ExpressRouteCircuitPeeringConfig'
          description: The Microsoft peering configuration.
        stats:
          $ref: '#/components/schemas/ExpressRouteCircuitStats'
          description: The peering stats of express route circuit.
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route circuit peering resource.
          readOnly: true
        gatewayManagerEtag:
          type: string
          description: The GatewayManager Etag.
        lastModifiedBy:
          type: string
          description: Who was the last to modify the peering.
          readOnly: true
        routeFilter:
          $ref: ./common.json#/definitions/SubResource
          description: The reference to the RouteFilter resource.
        ipv6PeeringConfig:
          $ref: '#/components/schemas/Ipv6ExpressRouteCircuitPeeringConfig'
          description: The IPv6 peering configuration.
        expressRouteConnection:
          $ref: ./virtualWan.json#/definitions/ExpressRouteConnectionId
          description: The ExpressRoute connection.
        connections:
          type: array
          description: The list of circuit connections associated with Azure Private Peering for this circuit.
          items:
            $ref: '#/components/schemas/ExpressRouteCircuitConnection'
        peeredConnections:
          type: array
          description: The list of peered circuit connections associated with Azure Private Peering for this circuit.
          items:
            $ref: '#/components/schemas/PeerExpressRouteCircuitConnection'
          readOnly: true
    ExpressRouteCircuitPeeringConfig:
      type: object
      description: Specifies the peering configuration.
      properties:
        advertisedPublicPrefixes:
          type: array
          description: The reference to AdvertisedPublicPrefixes.
          items:
            type: string
        advertisedCommunities:
          type: array
          description: The communities of bgp peering. Specified for microsoft peering.
          items:
            type: string
        advertisedPublicPrefixesState:
          $ref: ./common.json#/definitions/ExpressRouteCircuitPeeringAdvertisedPublicPrefixState
          description: The advertised public prefix state of the Peering resource.
          readOnly: true
        legacyMode:
          type: integer
          format: int32
          description: The legacy mode of the peering.
        customerASN:
          type: integer
          format: int32
          description: The CustomerASN of the peering.
        routingRegistryName:
          type: string
          description: The RoutingRegistryName of the configuration.
        advertisedPublicPrefixInfo:
          type: array
          description: List of Prefix information required to perform validation.
          items:
            $ref: '#/components/schemas/AdvertisedPublicPrefixProperties'
          x-ms-identifiers: []
    ExpressRouteCircuitConnectionPropertiesFormat:
      type: object
      description: Properties of the express route circuit connection.
      properties:
        expressRouteCircuitPeering:
          $ref: ./common.json#/definitions/SubResource
          description: Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
        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.
        authorizationKey:
          type: string
          description: The authorization key.
        ipv6CircuitConnectionConfig:
          $ref: '#/components/schemas/Ipv6CircuitConnectionConfig'
          description: IPv6 Address PrefixProperties of the express route circuit connection.
        circuitConnectionStatus:
          $ref: ./common.json#/definitions/CircuitConnectionStatus
          description: Express Route Circuit connection state.
          readOnly: true
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route circuit connection resource.
          readOnly: true
    AdvertisedPublicPrefixProperties:
      type: object
      description: Prefix properties required to perform validation using openssl signature.
      properties:
        prefix:
          type: string
          description: Advertised Public Prefix.
        validationId:
          type: string
          description: Validation string that contains circuit peering info.
        signature:
          type: string
          description: Signed string generated by encrypting validationId with a private key.
        validationState:
          $ref: ./common.json#/definitions/AdvertisedPublicPrefixPropertiesValidationState
          description: Advertised Public Prefix State that denotes if the prefix is validated or not.
          readOnly: true
    ExpressRouteCircuitPeering:
      type: object
      description: Peering in an ExpressRouteCircuit resource.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteCircuitPeeringPropertiesFormat'
          description: Properties of the express route circuit peering.
          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
    ExpressRouteCircuitPeeringListResult:
      type: object
      description: The response of a ExpressRouteCircuitPeering list operation.
      properties:
        value:
          type: array
          description: The ExpressRouteCircuitPeering items on this page
          items:
            $ref: '#/components/schemas/ExpressRouteCircuitPeering'
        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
    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
    Ipv6CircuitConnectionConfig:
      type: object
      description: IPv6 Circuit Connection properties for global reach.
      properties:
        addressPrefix:
          type: string
          description: /125 IP address space to carve out customer addresses for global reach.
        circuitConnectionStatus:
          $ref: ./common.json#/definitions/CircuitConnectionStatus
          description: Express Route Circuit connection state.
          readOnly: true
    ExpressRouteCircuitConnection:
      type: object
      description: Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteCircuitConnectionPropertiesFormat'
          description: Properties of the 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
    ExpressRouteCircuitStats:
      type: object
      description: Contains stats associated with the peering.
      properties:
        primarybytesIn:
          type: integer
          format: int64
          description: The Primary BytesIn of the peering.
        primarybytesOut:
          type: integer
          format: int64
          description: The primary BytesOut of the peering.
        secondarybytesIn:
          type: integer
          format: int64
          description: The secondary BytesIn of the peering.
        secondarybytesOut:
          type: integer
          format: int64
          description: The secondary BytesOut of the peering.
  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