Microsoft Azure ExpressRouteCrossConnectionPeerings API

openapi: 3.2.0
info:
  title: Microsoft Azure ExpressRouteCrossConnection REST Express…
  description: The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit.
  version: '2023-11-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ExpressRouteCrossConnectionPeerings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings
  : get:
      tags:
      - ExpressRouteCrossConnectionPeerings
      operationId: microsoftAzureExpressroutecrossconnectionpeeringsList
      description: Gets all peerings in a specified ExpressRouteCrossConnection.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: crossConnectionName
        in: path
        required: true
        description: The name of the ExpressRouteCrossConnection.
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnectionPeeringList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteCrossConnectionBgpPeeringList:
          $ref: ./examples/ExpressRouteCrossConnectionBgpPeeringList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}
  : delete:
      tags:
      - ExpressRouteCrossConnectionPeerings
      operationId: microsoftAzureExpressroutecrossconnectionpeeringsDelete
      description: Deletes the specified peering from the ExpressRouteCrossConnection.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: crossConnectionName
        in: path
        required: true
        description: The name of the ExpressRouteCrossConnection.
        schema:
          type: string
      - name: peeringName
        in: path
        required: true
        description: The name of the peering.
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Delete successful.
        '202':
          description: Accepted and the operation will complete asynchronously.
        '204':
          description: Delete successful.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        DeleteExpressRouteCrossConnectionBgpPeering:
          $ref: ./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
    get:
      tags:
      - ExpressRouteCrossConnectionPeerings
      operationId: microsoftAzureExpressroutecrossconnectionpeeringsGet
      description: Gets the specified peering for the ExpressRouteCrossConnection.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: crossConnectionName
        in: path
        required: true
        description: The name of the ExpressRouteCrossConnection.
        schema:
          type: string
      - name: peeringName
        in: path
        required: true
        description: The name of the peering.
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnectionPeering'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        GetExpressRouteCrossConnectionBgpPeering:
          $ref: ./examples/ExpressRouteCrossConnectionBgpPeeringGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - ExpressRouteCrossConnectionPeerings
      operationId: microsoftAzureExpressroutecrossconnectionpeeringsCreateorupdate
      description: Creates or updates a peering in the specified ExpressRouteCrossConnection.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: crossConnectionName
        in: path
        required: true
        description: The name of the ExpressRouteCrossConnection.
        schema:
          type: string
      - name: peeringName
        in: path
        required: true
        description: The name of the peering.
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Update successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnectionPeering'
        '201':
          description: Create successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnectionPeering'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteCrossConnectionBgpPeeringCreate:
          $ref: ./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRouteCrossConnectionPeering'
        description: Parameters supplied to the create or update ExpressRouteCrossConnection peering operation.
        required: true
components:
  schemas:
    ExpressRouteCrossConnectionPeeringList:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ExpressRouteCrossConnectionPeering'
          description: The peerings in an express route cross connection.
        nextLink:
          readOnly: true
          type: string
          description: The URL to get the next set of results.
      description: Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection.
    ExpressRouteCrossConnectionPeering:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ExpressRouteCrossConnectionPeeringProperties'
          description: Properties of the express route cross connection peering.
        name:
          type: string
          description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
        etag:
          readOnly: true
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
      allOf:
      - $ref: ./network.json#/definitions/SubResource
      description: Peering in an ExpressRoute Cross Connection resource.
    ExpressRouteCrossConnectionPeeringProperties:
      properties:
        peeringType:
          $ref: ./expressRouteCircuit.json#/definitions/ExpressRoutePeeringType
          description: The peering type.
        state:
          $ref: ./expressRouteCircuit.json#/definitions/ExpressRoutePeeringState
          description: The peering state.
        azureASN:
          readOnly: true
          type: integer
          format: int32
          description: The Azure ASN.
        peerASN:
          type: integer
          format: int64
          minimum: 1
          maximum: 4294967295
          description: The peer ASN.
        primaryPeerAddressPrefix:
          type: string
          description: The primary address prefix.
        secondaryPeerAddressPrefix:
          type: string
          description: The secondary address prefix.
        primaryAzurePort:
          readOnly: true
          type: string
          description: The primary port.
        secondaryAzurePort:
          readOnly: true
          type: string
          description: The secondary port.
        sharedKey:
          type: string
          description: The shared key.
        vlanId:
          type: integer
          format: int32
          description: The VLAN ID.
        microsoftPeeringConfig:
          $ref: ./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeeringConfig
          description: The Microsoft peering configuration.
        provisioningState:
          readOnly: true
          $ref: ./network.json#/definitions/ProvisioningState
          description: The provisioning state of the express route cross connection peering resource.
        gatewayManagerEtag:
          type: string
          description: The GatewayManager Etag.
        lastModifiedBy:
          readOnly: true
          type: string
          description: Who was the last to modify the peering.
        ipv6PeeringConfig:
          $ref: ./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig
          description: The IPv6 peering configuration.
      description: Properties of express route cross connection 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.