Azure ExpressRoute Express Route Ports API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Express Route Ports API
  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 ExpressRoutePorts 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: ExpressRoutePorts
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts:
    get:
      operationId: ExpressRoutePorts_List
      tags:
      - ExpressRoutePorts
      description: List all the ExpressRoutePort resources in the specified subscription.
      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/ExpressRoutePortListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortList:
          $ref: ./examples/ExpressRoutePortList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route ports list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts:
    get:
      operationId: ExpressRoutePorts_ListByResourceGroup
      tags:
      - ExpressRoutePorts
      description: List all the ExpressRoutePort resources in the specified resource group.
      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
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePortListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortListByResourceGroup:
          $ref: ./examples/ExpressRoutePortListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route ports list by resource group
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}
  : get:
      operationId: ExpressRoutePorts_Get
      tags:
      - ExpressRoutePorts
      description: Retrieves the requested ExpressRoutePort resource.
      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: expressRoutePortName
        in: path
        description: The name of ExpressRoutePort.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePort'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortGet:
          $ref: ./examples/ExpressRoutePortGet.json
      summary: Express route ports get
      x-summary-source: derived
    put:
      operationId: ExpressRoutePorts_CreateOrUpdate
      tags:
      - ExpressRoutePorts
      description: Creates or updates the specified ExpressRoutePort resource.
      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: expressRoutePortName
        in: path
        description: The name of ExpressRoutePort.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'ExpressRoutePort' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePort'
        '201':
          description: Resource 'ExpressRoutePort' 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/ExpressRoutePort'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortCreate:
          $ref: ./examples/ExpressRoutePortCreate.json
        ExpressRoutePortUpdateLink:
          $ref: ./examples/ExpressRoutePortUpdateLink.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/ExpressRoutePort'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRoutePort'
        description: Parameters supplied to the create ExpressRoutePort operation.
        required: true
      summary: Express route ports create or update
      x-summary-source: derived
    patch:
      operationId: ExpressRoutePorts_UpdateTags
      tags:
      - ExpressRoutePorts
      description: Update ExpressRoutePort tags.
      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: expressRoutePortName
        in: path
        description: The name of ExpressRoutePort.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRoutePort'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRoutePortUpdateTags:
          $ref: ./examples/ExpressRoutePortUpdateTags.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./common.json#/definitions/TagsObject
        description: Parameters supplied to update ExpressRoutePort resource tags.
        required: true
      summary: Express route ports update tags
      x-summary-source: derived
    delete:
      operationId: ExpressRoutePorts_Delete
      tags:
      - ExpressRoutePorts
      description: Deletes the specified ExpressRoutePort resource.
      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: expressRoutePortName
        in: path
        description: The name of ExpressRoutePort.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            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:
        ExpressRoutePortDelete:
          $ref: ./examples/ExpressRoutePortDelete.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Express route ports delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/generateLoa
  : post:
      operationId: ExpressRoutePorts_GenerateLOA
      tags:
      - ExpressRoutePorts
      description: Generate a letter of authorization for the requested ExpressRoutePort resource.
      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: expressRoutePortName
        in: path
        description: The name of ExpressRoutePort.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateExpressRoutePortsLOAResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        GenerateExpressRoutePortLOA:
          $ref: ./examples/GenerateExpressRoutePortsLOA.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateExpressRoutePortsLOARequest'
        description: Request parameters supplied to generate a letter of authorization.
        required: true
      summary: Express route ports generate LOA
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ExpressRouteLink:
      type: object
      title: ExpressRouteLink
      description: ExpressRouteLink child resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteLinkPropertiesFormat'
          description: ExpressRouteLink properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Name of child port resource that is unique among child port resources of the parent.
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: ./common.json#/definitions/SubResource
    ExpressRouteLinkPropertiesFormat:
      type: object
      title: ExpressRouteLink Resource Properties
      description: Properties specific to ExpressRouteLink resources.
      properties:
        routerName:
          type: string
          description: Name of Azure router associated with physical port.
          readOnly: true
        interfaceName:
          type: string
          description: Name of Azure router interface.
          readOnly: true
        patchPanelId:
          type: string
          description: Mapping between physical port to patch panel port.
          readOnly: true
        rackId:
          type: string
          description: Mapping of physical patch panel to rack.
          readOnly: true
        coloLocation:
          type: string
          description: Cololocation for ExpressRoute Hybrid Direct.
          readOnly: true
        connectorType:
          $ref: ./common.json#/definitions/ExpressRouteLinkConnectorType
          description: Physical fiber port type.
          readOnly: true
        adminState:
          $ref: ./common.json#/definitions/ExpressRouteLinkAdminState
          description: Administrative state of the physical port.
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route link resource.
          readOnly: true
        macSecConfig:
          $ref: '#/components/schemas/ExpressRouteLinkMacSecConfig'
          description: MacSec configuration.
    GenerateExpressRoutePortsLOARequest:
      type: object
      description: The customer name to be printed on a letter of authorization.
      properties:
        customerName:
          type: string
          description: The customer name.
      required:
      - customerName
    GenerateExpressRoutePortsLOAResult:
      type: object
      description: Response for GenerateExpressRoutePortsLOA API service call.
      properties:
        encodedContent:
          type: string
          description: The content as a base64 encoded string.
    ExpressRoutePortListResult:
      type: object
      title: ExpressRoute Port List Result
      description: Paged collection of ExpressRoutePort items
      properties:
        value:
          type: array
          description: The ExpressRoutePort items on this page
          items:
            $ref: '#/components/schemas/ExpressRoutePort'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExpressRoutePortPropertiesFormat:
      type: object
      title: ExpressRoutePort Properties
      description: Properties specific to ExpressRoutePort resources.
      properties:
        peeringLocation:
          type: string
          description: The name of the peering location that the ExpressRoutePort is mapped to physically.
        bandwidthInGbps:
          type: integer
          format: int32
          description: Bandwidth of procured ports in Gbps.
        provisionedBandwidthInGbps:
          type: number
          format: float
          description: Aggregate Gbps of associated circuit bandwidths.
          readOnly: true
        mtu:
          type: string
          description: Maximum transmission unit of the physical port pair(s).
          readOnly: true
        encapsulation:
          $ref: ./common.json#/definitions/ExpressRoutePortsEncapsulation
          description: Encapsulation method on physical ports.
        etherType:
          type: string
          description: Ether type of the physical port.
          readOnly: true
        allocationDate:
          type: string
          description: Date of the physical port allocation to be used in Letter of Authorization.
          readOnly: true
        links:
          type: array
          title: ExpressRouteLink Sub-Resources
          description: The set of physical links of the ExpressRoutePort resource.
          items:
            $ref: '#/components/schemas/ExpressRouteLink'
        circuits:
          type: array
          description: Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
          items:
            $ref: ./common.json#/definitions/SubResource
          readOnly: true
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route port resource.
          readOnly: true
        resourceGuid:
          type: string
          description: The resource GUID property of the express route port resource.
          readOnly: true
        billingType:
          $ref: ./common.json#/definitions/ExpressRoutePortsBillingType
          description: The billing type of the ExpressRoutePort resource.
    ExpressRouteLinkMacSecConfig:
      type: object
      title: Definition of ExpressRouteLink Mac Security configuration.
      description: ExpressRouteLink Mac Security Configuration.
      properties:
        cknSecretIdentifier:
          type: string
          description: Keyvault Secret Identifier URL containing Mac security CKN key.
        cakSecretIdentifier:
          type: string
          description: Keyvault Secret Identifier URL containing Mac security CAK key.
        cipher:
          $ref: ./common.json#/definitions/ExpressRouteLinkMacSecCipher
          description: Mac security cipher.
        sciState:
          $ref: ./common.json#/definitions/ExpressRouteLinkMacSecSciState
          description: Sci mode enabled/disabled.
    ExpressRoutePort:
      type: object
      title: ExpressRoute Port
      description: ExpressRoutePort resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRoutePortPropertiesFormat'
          description: ExpressRoutePort properties.
          x-ms-client-flatten: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
        identity:
          $ref: ./common.json#/definitions/ManagedServiceIdentity
          description: The identity of ExpressRoutePort, if configured.
      allOf:
      - $ref: ./common.json#/definitions/Resource
  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