Azure ExpressRoute Express Route Links API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Express Route Links 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 ExpressRouteLinks 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: ExpressRouteLinks
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links
  : get:
      operationId: ExpressRouteLinks_List
      tags:
      - ExpressRouteLinks
      description: Retrieve the ExpressRouteLink sub-resources of 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: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteLinkListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteLinkGet:
          $ref: ./examples/ExpressRouteLinkList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route links list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}
  : get:
      operationId: ExpressRouteLinks_Get
      tags:
      - ExpressRouteLinks
      description: Retrieves the specified ExpressRouteLink 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 the express route port.
        required: true
        schema:
          type: string
      - name: linkName
        in: path
        description: The name of the express route link.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteLink'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        ExpressRouteLinkGet:
          $ref: ./examples/ExpressRouteLinkGet.json
      summary: Express route links get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    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.
    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
    ExpressRouteLinkListResult:
      type: object
      title: ExpressRouteLink List Result
      description: Response for ListExpressRouteLinks API service call.
      properties:
        value:
          type: array
          description: The ExpressRouteLink items on this page
          items:
            $ref: '#/components/schemas/ExpressRouteLink'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    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.
  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