Azure ExpressRoute Express Route Ports Locations API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Express Route Ports Locations…
  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 ExpressRoutePortsLocations 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: ExpressRoutePortsLocations
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations:
    get:
      operationId: ExpressRoutePortsLocations_List
      tags:
      - ExpressRoutePortsLocations
      description: Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePortsLocationListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortsLocationList:
          $ref: ./examples/ExpressRoutePortsLocationList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route ports locations list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}:
    get:
      operationId: ExpressRoutePortsLocations_Get
      tags:
      - ExpressRoutePortsLocations
      description: Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: locationName
        in: path
        description: Name of the requested ExpressRoutePort peering location.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePortsLocation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortsLocationGet:
          $ref: ./examples/ExpressRoutePortsLocationGet.json
      summary: Express route ports locations get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ExpressRoutePortsLocationBandwidths:
      type: object
      title: ExpressRoutePorts Location Bandwidths
      description: Real-time inventory of available ExpressRoute port bandwidths.
      properties:
        offerName:
          type: string
          description: Bandwidth descriptive name.
          readOnly: true
        valueInGbps:
          type: integer
          format: int32
          description: Bandwidth value in Gbps.
          readOnly: true
    ExpressRoutePortsLocation:
      type: object
      title: ExpressRoutePorts Peering Location
      description: Definition of the ExpressRoutePorts peering location resource.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRoutePortsLocationPropertiesFormat'
          description: ExpressRoutePort peering location properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ./common.json#/definitions/Resource
    ExpressRoutePortsLocationListResult:
      type: object
      title: ExpressRoutePorts Location List Result
      description: Paged collection of ExpressRoutePortsLocation items
      properties:
        value:
          type: array
          description: The ExpressRoutePortsLocation items on this page
          items:
            $ref: '#/components/schemas/ExpressRoutePortsLocation'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExpressRoutePortsLocationPropertiesFormat:
      type: object
      title: ExpressRoutePorts Location Properties
      description: Properties specific to ExpressRoutePorts peering location resources.
      properties:
        address:
          type: string
          description: Address of peering location.
          readOnly: true
        contact:
          type: string
          description: Contact details of peering locations.
          readOnly: true
        availableBandwidths:
          type: array
          description: The inventory of available ExpressRoutePort bandwidths.
          items:
            $ref: '#/components/schemas/ExpressRoutePortsLocationBandwidths'
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route port location 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