Azure ExpressRoute Express Route Provider Ports API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Express Route Provider Ports…
  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 ExpressRouteProviderPorts 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: ExpressRouteProviderPorts
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts:
    get:
      operationId: ExpressRouteProviderPortsLocation_List
      tags:
      - ExpressRouteProviderPorts
      description: Retrieves all the ExpressRouteProviderPorts in a subscription.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: $filter
        in: query
        description: The filter to apply on the operation. For example, you can use $filter=location eq '{state}'.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteProviderPortListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteProviderPortList:
          $ref: ./examples/expressRouteProviderPortList.json
      summary: Express route provider ports location list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{providerport}:
    get:
      operationId: ExpressRouteProviderPort
      tags:
      - ExpressRouteProviderPorts
      description: Retrieves detail of a provider port.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: providerport
        in: path
        description: The name of the provider port.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteProviderPort'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteProviderPort:
          $ref: ./examples/expressRouteProviderPort.json
      summary: Express route provider port
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ExpressRouteProviderPort:
      type: object
      description: ExpressRouteProviderPort resource.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteProviderPortProperties'
          description: Properties of the express route Service Provider Port.
          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/TrackedResourceWithOptionalLocation
    ExpressRouteProviderPortListResult:
      type: object
      description: Response for ListExpressRouteProviderPort API service call.
      properties:
        value:
          type: array
          description: The ExpressRouteProviderPort items on this page
          items:
            $ref: '#/components/schemas/ExpressRouteProviderPort'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
          readOnly: true
      required:
      - value
    ExpressRouteProviderPortProperties:
      type: object
      description: Properties of ExpressRouteProviderPort.
      properties:
        portPairDescriptor:
          type: string
          description: The name of the port pair.
          readOnly: true
        primaryAzurePort:
          type: string
          description: The name of the primary port.
          readOnly: true
        secondaryAzurePort:
          type: string
          description: The name of the secondary port.
          readOnly: true
        peeringLocation:
          type: string
          description: The peering location of the port pair.
        overprovisionFactor:
          type: integer
          format: int32
          description: Overprovisioning factor for the port pair.
        portBandwidthInMbps:
          type: integer
          format: int32
          description: Bandwidth of the port in Mbps
        usedBandwidthInMbps:
          type: integer
          format: int32
          description: Used Bandwidth of the port in Mbps
        remainingBandwidthInMbps:
          type: integer
          format: int32
          description: Remaining Bandwidth of the port in Mbps
  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