openapi: 3.2.0
info:
  title: Microsoft Azure RoutingConfiguration Routing Rules API
  version: 2023-03-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Routing Rules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules
  : 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
    - $ref: '#/components/parameters/NetworkManagerNameParameter'
    - $ref: '#/components/parameters/RoutingConfigurationParameter'
    - $ref: '#/components/parameters/RuleCollectionParameter'
    - $ref: '#/components/parameters/ListTopParameter'
    - $ref: '#/components/parameters/ListSkipTokenParameter'
    get:
      tags:
      - Routing Rules
      description: List all network manager routing configuration routing rules.
      operationId: microsoftAzureRoutingrulesList
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingRuleListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        List routing rules:
          $ref: ./examples/NetworkManagerRoutingRuleList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
  : 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
    - $ref: '#/components/parameters/NetworkManagerNameParameter'
    - $ref: '#/components/parameters/RoutingConfigurationParameter'
    - $ref: '#/components/parameters/RuleCollectionParameter'
    - $ref: '#/components/parameters/RoutingConfigurationsRuleParameter'
    get:
      tags:
      - Routing Rules
      description: Gets a network manager routing configuration routing rule.
      operationId: microsoftAzureRoutingrulesGet
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingRule'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Gets routing rule:
          $ref: ./examples/NetworkManagerRoutingRuleGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - Routing Rules
      description: Creates or updates an routing rule.
      operationId: microsoftAzureRoutingrulesCreateorupdate
      responses:
        '200':
          description: Updated rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingRule'
        '201':
          description: Created rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingRule'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Create an routing rule:
          $ref: ./examples/NetworkManagerRoutingRulePut.json
        Create a default routing rule:
          $ref: ./examples/NetworkManagerRoutingRulePut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingRule'
        description: The routing rule to create or update
        required: true
    delete:
      tags:
      - Routing Rules
      description: Deletes a routing rule.
      operationId: microsoftAzureRoutingrulesDelete
      responses:
        '202':
          description: Accepted and will complete asynchronously.
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              schema:
                type: string
        '204':
          description: Request successful. Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ./network.json#/definitions/CloudError
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Deletes a routing rule:
          $ref: ./examples/NetworkManagerRoutingRuleDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    RoutingRuleListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/RoutingRule'
          description: A list of routing rules.
        nextLink:
          type: string
          description: The URL to get the next set of results.
      description: Routing configuration rule list result.
    RoutingRule:
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/RoutingRulePropertiesFormat'
          x-ms-client-flatten: true
          description: Indicates the properties of the routing rule
        systemData:
          readOnly: true
          description: The system metadata related to this resource.
          $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
      allOf:
      - $ref: ./network.json#/definitions/ProxyResource
      description: Network routing rule.
    RoutingRuleRouteDestination:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/RoutingRuleDestinationType'
          description: Destination type.
        destinationAddress:
          type: string
          description: Destination address.
      required:
      - type
      - destinationAddress
      description: Route destination.
    RoutingRuleDestinationType:
      type: string
      description: Routing rule destination type.
      enum:
      - AddressPrefix
      - ServiceTag
      x-ms-enum:
        name: RoutingRuleDestinationType
        modelAsString: true
    RoutingRuleNextHop:
      type: object
      properties:
        nextHopType:
          $ref: '#/components/schemas/RoutingRuleNextHopType'
          description: Next hop type.
        nextHopAddress:
          type: string
          description: Next hop address. Only relevant if the next hop type is VirtualAppliance.
      required:
      - nextHopType
      description: Next hop.
    RoutingRulePropertiesFormat:
      type: object
      properties:
        description:
          type: string
          description: A description for this rule.
        provisioningState:
          readOnly: true
          $ref: ./network.json#/definitions/ProvisioningState
          description: The provisioning state of the resource.
        resourceGuid:
          type: string
          readOnly: true
          description: Unique identifier for this resource.
        destination:
          $ref: '#/components/schemas/RoutingRuleRouteDestination'
          description: Indicates the destination for this particular rule.
        nextHop:
          $ref: '#/components/schemas/RoutingRuleNextHop'
          description: Indicates the next hop for this particular rule.
      required:
      - destination
      - nextHop
      description: Routing routing rule resource.
    RoutingRuleNextHopType:
      type: string
      description: Routing rule next hop type.
      enum:
      - Internet
      - NoNextNop
      - VirtualAppliance
      - VirtualNetworkGateway
      - VnetLocal
      x-ms-enum:
        name: RoutingRuleNextHopType
        modelAsString: true
  parameters:
    NetworkManagerNameParameter:
      name: networkManagerName
      in: path
      required: true
      description: The name of the network manager.
      x-ms-parameter-location: method
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_.-]*$
    ListSkipTokenParameter:
      name: $skipToken
      description: SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    RoutingConfigurationParameter:
      name: configurationName
      in: path
      description: The name of the network manager Routing Configuration.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_.-]*$
    RoutingConfigurationsRuleParameter:
      name: ruleName
      in: path
      description: The name of the rule.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_.-]*$
    ListTopParameter:
      name: $top
      description: An optional query parameter which specifies the maximum number of records to be returned by the server.
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        maximum: 20
        minimum: 1
    RuleCollectionParameter:
      name: ruleCollectionName
      in: path
      description: The name of the network manager routing Configuration rule collection.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_.-]*$
  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.