Azure ExpressRoute Route Filter Rules API

openapi: 3.2.0
info:
  title: Microsoft Azure Express Route Route Filter Rules 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 RouteFilterRules 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: RouteFilterRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules
  : get:
      operationId: RouteFilterRules_ListByRouteFilter
      tags:
      - RouteFilterRules
      description: Gets all RouteFilterRules in a route filter.
      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: routeFilterName
        in: path
        description: The name of the route filter.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFilterRuleListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        RouteFilterRuleListByRouteFilter:
          $ref: ./examples/RouteFilterRuleListByRouteFilter.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Route filter rules list by route filter
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}
  : get:
      operationId: RouteFilterRules_Get
      tags:
      - RouteFilterRules
      description: Gets the specified rule from a route filter.
      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: routeFilterName
        in: path
        description: The name of the route filter.
        required: true
        schema:
          type: string
      - name: ruleName
        in: path
        description: The name of the route filter rule.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFilterRule'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        RouteFilterRuleGet:
          $ref: ./examples/RouteFilterRuleGet.json
      summary: Route filter rules get
      x-summary-source: derived
    put:
      operationId: RouteFilterRules_CreateOrUpdate
      tags:
      - RouteFilterRules
      description: Creates or updates a route in the specified route filter.
      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: routeFilterName
        in: path
        description: The name of the route filter.
        required: true
        schema:
          type: string
      - name: ruleName
        in: path
        description: The name of the route filter rule.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFilterRule'
        '201':
          description: Resource 'RouteFilterRule' 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/RouteFilterRule'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        RouteFilterRuleCreate:
          $ref: ./examples/RouteFilterRuleCreate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
        final-state-schema: '#/definitions/RouteFilterRule'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteFilterRule'
        description: Parameters supplied to the create or update route filter rule operation.
        required: true
      summary: Route filter rules create or update
      x-summary-source: derived
    delete:
      operationId: RouteFilterRules_Delete
      tags:
      - RouteFilterRules
      description: Deletes the specified rule from a route filter.
      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: routeFilterName
        in: path
        description: The name of the route filter.
        required: true
        schema:
          type: string
      - name: ruleName
        in: path
        description: The name of the route filter rule.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
        '202':
          description: Resource operation 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: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ./common.json#/definitions/CloudError
      x-ms-examples:
        RouteFilterRuleDelete:
          $ref: ./examples/RouteFilterRuleDelete.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Route filter rules delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    RouteFilterRule:
      type: object
      description: Route Filter Rule Resource.
      properties:
        properties:
          $ref: '#/components/schemas/RouteFilterRulePropertiesFormat'
          description: Properties of the route filter rule.
          x-ms-client-flatten: true
        name:
          type: string
          description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
        location:
          type: string
          description: Resource location.
        etag:
          type: string
          description: A unique read-only string that changes whenever the resource is updated.
          readOnly: true
      allOf:
      - $ref: ./common.json#/definitions/SubResource
    RouteFilterRulePropertiesFormat:
      type: object
      description: Route Filter Rule Resource.
      properties:
        access:
          $ref: ./common.json#/definitions/Access
          description: The access type of the rule.
        routeFilterRuleType:
          $ref: ./common.json#/definitions/RouteFilterRuleType
          description: The rule type of the rule.
        communities:
          type: array
          description: The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
          items:
            type: string
        provisioningState:
          $ref: ./common.json#/definitions/ProvisioningState
          description: The provisioning state of the route filter rule resource.
          readOnly: true
      required:
      - access
      - routeFilterRuleType
      - communities
    RouteFilterRuleListResult:
      type: object
      description: Response for the ListRouteFilterRules API service call.
      properties:
        value:
          type: array
          description: The RouteFilterRule items on this page
          items:
            $ref: '#/components/schemas/RouteFilterRule'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  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