Microsoft Azure ExpressRouteCrossConnections 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: ExpressRouteCrossConnections
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections:
    get:
      tags:
      - ExpressRouteCrossConnections
      operationId: microsoftAzureExpressroutecrossconnectionsList
      description: Retrieves all the ExpressRouteCrossConnections in a subscription.
      parameters:
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnectionListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteCrossConnectionList:
          $ref: ./examples/ExpressRouteCrossConnectionList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections
  : get:
      tags:
      - ExpressRouteCrossConnections
      operationId: microsoftAzureExpressroutecrossconnectionsListbyresourcegroup
      description: Retrieves all the ExpressRouteCrossConnections in a resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnectionListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteCrossConnectionListByResourceGroup:
          $ref: ./examples/ExpressRouteCrossConnectionListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}
  : get:
      tags:
      - ExpressRouteCrossConnections
      operationId: microsoftAzureExpressroutecrossconnectionsGet
      description: Gets details about the specified ExpressRouteCrossConnection.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group (peering location of the circuit).
        schema:
          type: string
      - name: crossConnectionName
        in: path
        required: true
        description: The name of the ExpressRouteCrossConnection (service key of the circuit).
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Request successful. The operation returns the resulting ExpressRouteCrossConnection resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        GetExpressRouteCrossConnection:
          $ref: ./examples/ExpressRouteCrossConnectionGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - ExpressRouteCrossConnections
      operationId: microsoftAzureExpressroutecrossconnectionsCreateorupdate
      description: Update 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
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        UpdateExpressRouteCrossConnection:
          $ref: ./examples/ExpressRouteCrossConnectionUpdate.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/ExpressRouteCrossConnection'
        description: Parameters supplied to the update express route crossConnection operation.
        required: true
    patch:
      tags:
      - ExpressRouteCrossConnections
      operationId: microsoftAzureExpressroutecrossconnectionsUpdatetags
      description: Updates an express route cross connection tags.
      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 cross connection.
        schema:
          type: string
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteCrossConnection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        UpdateExpressRouteCrossConnectionTags:
          $ref: ./examples/ExpressRouteCrossConnectionUpdateTags.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./network.json#/definitions/TagsObject
        description: Parameters supplied to update express route cross connection tags.
        required: true
components:
  schemas:
    ExpressRouteCrossConnectionProperties:
      properties:
        primaryAzurePort:
          readOnly: true
          type: string
          description: The name of the primary port.
        secondaryAzurePort:
          readOnly: true
          type: string
          description: The name of the secondary port.
        sTag:
          readOnly: true
          type: integer
          description: The identifier of the circuit traffic.
        peeringLocation:
          readOnly: true
          type: string
          description: The peering location of the ExpressRoute circuit.
        bandwidthInMbps:
          readOnly: true
          type: integer
          format: int32
          description: The circuit bandwidth In Mbps.
        expressRouteCircuit:
          $ref: '#/components/schemas/ExpressRouteCircuitReference'
          description: The ExpressRouteCircuit.
        serviceProviderProvisioningState:
          $ref: ./expressRouteCircuit.json#/definitions/ServiceProviderProvisioningState
          description: The provisioning state of the circuit in the connectivity provider system.
        serviceProviderNotes:
          type: string
          description: Additional read only notes set by the connectivity provider.
        provisioningState:
          readOnly: true
          $ref: ./network.json#/definitions/ProvisioningState
          description: The provisioning state of the express route cross connection resource.
        peerings:
          type: array
          items:
            $ref: '#/components/schemas/ExpressRouteCrossConnectionPeering'
          description: The list of peerings.
      description: Properties of 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.
    ExpressRouteCircuitReference:
      properties:
        id:
          type: string
          description: Corresponding Express Route Circuit Id.
      description: Reference to an express route circuit.
    ExpressRouteCrossConnection:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ExpressRouteCrossConnectionProperties'
          description: Properties of the express route cross connection.
        etag:
          readOnly: true
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
      allOf:
      - $ref: ./network.json#/definitions/Resource
      description: ExpressRouteCrossConnection 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.
    ExpressRouteCrossConnectionListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ExpressRouteCrossConnection'
          description: A list of ExpressRouteCrossConnection resources.
        nextLink:
          readOnly: true
          type: string
          description: The URL to get the next set of results.
      description: Response for ListExpressRouteCrossConnection API service call.
  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.