Azure ExpressRoute Express Route Lags API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Express Route Lags 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 ExpressRouteLags 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: ExpressRouteLags
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteLags:
    get:
      operationId: ExpressRouteLags_List
      tags:
      - ExpressRouteLags
      description: List all the ExpressRouteLag 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/ExpressRouteLagListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List all express route lags:
          $ref: ./examples/ExpressRouteLagList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route lags list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags:
    get:
      operationId: ExpressRouteLags_ListByResourceGroup
      tags:
      - ExpressRouteLags
      description: List all the ExpressRouteLag 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/ExpressRouteLagListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        List express route lags by resource group:
          $ref: ./examples/ExpressRouteLagListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Express route lags list by resource group
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}
  : get:
      operationId: ExpressRouteLags_Get
      tags:
      - ExpressRouteLags
      description: Retrieves the requested ExpressRouteLag 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: expressRouteLagName
        in: path
        description: The name of ExpressRouteLag.
        required: true
        schema:
          type: string
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteLag'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Get express route lag:
          $ref: ./examples/ExpressRouteLagGet.json
      summary: Express route lags get
      x-summary-source: derived
    put:
      operationId: ExpressRouteLags_CreateOrUpdate
      tags:
      - ExpressRouteLags
      description: Creates or updates the specified ExpressRouteLag 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: expressRouteLagName
        in: path
        description: The name of ExpressRouteLag.
        required: true
        schema:
          type: string
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
      responses:
        '200':
          description: Resource 'ExpressRouteLag' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteLag'
        '201':
          description: Resource 'ExpressRouteLag' 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/ExpressRouteLag'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Create express route lag:
          $ref: ./examples/ExpressRouteLagCreate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/ExpressRouteLag'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRouteLag'
        description: Parameters supplied to the create ExpressRouteLag operation.
        required: true
      summary: Express route lags create or update
      x-summary-source: derived
    patch:
      operationId: ExpressRouteLags_Update
      tags:
      - ExpressRouteLags
      description: Update ExpressRouteLag tags or identity.
      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: expressRouteLagName
        in: path
        description: The name of ExpressRouteLag.
        required: true
        schema:
          type: string
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpressRouteLag'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Update express route lag tags or identity:
          $ref: ./examples/ExpressRouteLagPatch.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpressRouteLagUpdateTagsOrIdentityRequest'
        description: Parameters supplied to update ExpressRouteLag resource tags or identity.
        required: true
      summary: Express route lags update
      x-summary-source: derived
    delete:
      operationId: ExpressRouteLags_Delete
      tags:
      - ExpressRouteLags
      description: Deletes the specified ExpressRouteLag 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: expressRouteLagName
        in: path
        description: The name of ExpressRouteLag.
        required: true
        schema:
          type: string
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
      responses:
        '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:
        Delete express route lag:
          $ref: ./examples/ExpressRouteLagDelete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Express route lags delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteLags/{expressRouteLagName}/generateLoa
  : post:
      operationId: ExpressRouteLags_GenerateLoa
      tags:
      - ExpressRouteLags
      description: Generate a letter of authorization for the requested ExpressRouteLag 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: expressRouteLagName
        in: path
        description: The name of ExpressRouteLag.
        required: true
        schema:
          type: string
          maxLength: 80
          minLength: 1
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateExpressRouteLagsLOAResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        Generate express route lag LOA:
          $ref: ./examples/GenerateExpressRouteLagsLOA.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateExpressRouteLagsLOARequest'
        description: Request parameters supplied to generate a letter of authorization.
        required: true
      summary: Express route lags generate loa
      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.
    ExpressRouteLagLinkPropertiesFormat:
      type: object
      title: ExpressRouteLagLink Resource Properties
      description: Properties specific to ExpressRouteLagLink resources.
      properties:
        routerName:
          type: string
          description: Name of Azure router associated with link.
          readOnly: true
        interfaceName:
          type: string
          description: Name of Azure router interface.
          readOnly: true
        adminState:
          $ref: ./common.json#/definitions/ExpressRouteLinkAdminState
          description: Administrative state of the link.
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route LAG link resource.
          readOnly: true
        macSecConfig:
          $ref: '#/components/schemas/ExpressRouteLinkMacSecConfig'
          description: MacSec configuration.
        members:
          type: array
          title: ExpressRouteLagMember Sub-Resources
          description: The set of members of the ExpressRouteLagLink resource.
          items:
            $ref: '#/components/schemas/ExpressRouteLagMember'
    ExpressRouteLag:
      type: object
      title: ExpressRoute LAG
      description: ExpressRouteLag resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteLagPropertiesFormat'
          description: ExpressRouteLag properties.
        id:
          type: string
          description: The unique identifier of the resource.
          readOnly: true
        type:
          type: string
          description: The type of the resource.
          readOnly: 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 ExpressRouteLag, if configured.
      allOf:
      - $ref: ./common.json#/definitions/Resource
    GenerateExpressRouteLagsLOARequest:
      type: object
      description: The customer name to be printed on a letter of authorization for ExpressRouteLag.
      properties:
        customerName:
          type: string
          description: The customer name.
        members:
          type: array
          description: The list of member names for which LOA should be generated.
          items:
            type: string
      required:
      - customerName
    ExpressRouteLagListResult:
      type: object
      title: ExpressRoute LAG List Result
      description: Paged collection of ExpressRouteLag items
      properties:
        value:
          type: array
          description: The ExpressRouteLag items on this page
          items:
            $ref: '#/components/schemas/ExpressRouteLag'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExpressRouteLagPropertiesFormat:
      type: object
      title: ExpressRouteLag Resource Properties
      description: Properties specific to ExpressRouteLag resources.
      properties:
        peeringLocation:
          type: string
          description: The name of the peering location that the ExpressRouteLag is mapped to physically.
        bandwidthInGbps:
          type: integer
          format: int32
          description: Bandwidth of procured LAG in Gbps.
        provisionedBandwidthInGbps:
          type: number
          format: double
          description: Aggregate Gbps of associated circuit bandwidths.
          readOnly: true
        mtu:
          type: string
          description: Maximum transmission unit of the LAG.
          readOnly: true
        encapsulation:
          $ref: ./common.json#/definitions/ExpressRouteLagEncapsulation
          description: Encapsulation method on LAG.
        etherType:
          type: string
          description: Ether type of the LAG.
          readOnly: true
        links:
          type: array
          title: ExpressRouteLagLink Sub-Resources
          description: The set of links of the ExpressRouteLag resource.
          items:
            $ref: '#/components/schemas/ExpressRouteLagLink'
        circuits:
          type: array
          description: Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRouteLag resource.
          items:
            $ref: ./common.json#/definitions/SubResource
          readOnly: true
        authorizations:
          type: array
          title: ExpressRouteLagAuthorizations Child-Resources
          description: The set of authorizations of the ExpressRouteLag resource.
          items:
            $ref: '#/components/schemas/ExpressRouteLagAuthorization'
        allocationDate:
          type: string
          description: The date and time when the ExpressRouteLag was allocated.
          readOnly: true
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route LAG resource.
          readOnly: true
        resourceGuid:
          type: string
          description: The resource GUID property of the express route LAG resource.
          readOnly: true
        billingType:
          $ref: ./common.json#/definitions/ExpressRouteLagBillingType
          description: The billing type of the ExpressRouteLag resource.
        numberOfPorts:
          type: integer
          format: int32
          description: Number of ports in the LAG.
          minimum: 1
        minimumActivePortsRequired:
          type: integer
          format: int32
          description: Minimum number of active ports required for LAG.
          minimum: 1
        lacpTimer:
          $ref: ./common.json#/definitions/ExpressRouteLagLacpTimer
          description: LACP timer configuration.
    ExpressRouteLagAuthorization:
      type: object
      title: ExpressRoute Lag Authorization
      description: ExpressRouteLag Authorization resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteLagAuthorizationPropertiesFormat'
          description: ExpressRouteLag authorization properties.
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: ./common.json#/definitions/ProxyResourceWithReadOnlyID
    ExpressRouteLagMemberPropertiesFormat:
      type: object
      title: ExpressRouteLagMember Resource Properties
      description: Properties specific to ExpressRouteLagMember resources.
      properties:
        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 member.
          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 member port.
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the express route LAG member resource.
          readOnly: true
    ExpressRouteLagAuthorizationPropertiesFormat:
      type: object
      title: ExpressRoute Lag Authorization Properties
      description: Properties of ExpressRouteLag Authorization.
      properties:
        authorizationUseStatus:
          $ref: ./common.json#/definitions/ExpressRouteLagAuthorizationUseStatus
          description: The authorization use status.
          readOnly: true
        circuitResourceUri:
          type: string
          description: The reference to the ExpressRoute circuit resource using the authorization.
          readOnly: true
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the authorization resource.
          readOnly: true
    ExpressRouteLagUpdateTagsOrIdentityRequest:
      type: object
      title: ExpressRouteLag Update Tags or Identity Request
      description: Parameters for updating ExpressRouteLag tags or identity.
      properties:
        identity:
          $ref: ./common.json#/definitions/ManagedServiceIdentity
          description: The identity of ExpressRouteLag, if configured.
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
    GenerateExpressRouteLagsLOAResult:
      type: object
      description: Response for GenerateExpressRouteLagsLOA API service call.
      properties:
        encodedContent:
          type: string
          description: The content as a base64 encoded string.
    ExpressRouteLagLink:
      type: object
      title: ExpressRouteLagLink
      description: ExpressRouteLagLink child resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteLagLinkPropertiesFormat'
          description: ExpressRouteLagLink properties.
        id:
          type: string
          description: The unique identifier of the resource.
          readOnly: true
        type:
          type: string
          description: The type of the resource.
          readOnly: true
        name:
          type: string
          description: Name of child link resource that is unique among child link resources of the parent.
          readOnly: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      required:
      - id
      - type
      - name
      allOf:
      - $ref: ./common.json#/definitions/SubResource
    ExpressRouteLagMember:
      type: object
      title: ExpressRouteLagMember
      description: ExpressRouteLagMember child resource definition.
      properties:
        properties:
          $ref: '#/components/schemas/ExpressRouteLagMemberPropertiesFormat'
          description: ExpressRouteLagMember properties.
        id:
          type: string
          description: The unique identifier of the resource.
          readOnly: true
        type:
          type: string
          description: The type of the resource.
          readOnly: true
        name:
          type: string
          description: Name of child member resource that is unique among child member resources of the parent.
          readOnly: true
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      required:
      - id
      - type
      - name
      allOf:
      - $ref: ./common.json#/definitions/SubResource
  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