swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RoutingRules API
schemes:
- https
tags:
- name: RoutingRules
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: '#/parameters/NetworkManagerNameParameter'
    - $ref: '#/parameters/RoutingConfigurationParameter'
    - $ref: '#/parameters/RuleCollectionParameter'
    - $ref: '#/parameters/ListTopParameter'
    - $ref: '#/parameters/ListSkipTokenParameter'
    get:
      tags:
      - RoutingRules
      description: List all network manager routing configuration routing rules.
      operationId: microsoftAzureRoutingrulesList
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/RoutingRuleListResult'
        default:
          description: Error response describing why the operation failed.
          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 Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules
  ? /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: '#/parameters/NetworkManagerNameParameter'
    - $ref: '#/parameters/RoutingConfigurationParameter'
    - $ref: '#/parameters/RuleCollectionParameter'
    - $ref: '#/parameters/RoutingConfigurationsRuleParameter'
    get:
      tags:
      - RoutingRules
      description: Gets a network manager routing configuration routing rule.
      operationId: microsoftAzureRoutingrulesGet
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/RoutingRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Gets routing rule:
          $ref: ./examples/NetworkManagerRoutingRuleGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
    put:
      tags:
      - RoutingRules
      description: Creates or updates an routing rule.
      operationId: microsoftAzureRoutingrulesCreateorupdate
      parameters:
      - name: routingRule
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoutingRule'
        description: The routing rule to create or update
      responses:
        '200':
          description: Updated rule
          schema:
            $ref: '#/definitions/RoutingRule'
        '201':
          description: Created rule
          schema:
            $ref: '#/definitions/RoutingRule'
        default:
          description: Error response describing why the operation failed.
          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 Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
    delete:
      tags:
      - RoutingRules
      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.
              type: string
        '204':
          description: Request successful. Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          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 Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
definitions:
  RoutingRuleNextHop:
    type: object
    properties:
      nextHopType:
        $ref: '#/definitions/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.
  RoutingRuleDestinationType:
    type: string
    description: Routing rule destination type.
    enum:
    - AddressPrefix
    - ServiceTag
    x-ms-enum:
      name: RoutingRuleDestinationType
      modelAsString: true
  RoutingRuleRouteDestination:
    type: object
    properties:
      type:
        $ref: '#/definitions/RoutingRuleDestinationType'
        description: Destination type.
      destinationAddress:
        type: string
        description: Destination address.
    required:
    - type
    - destinationAddress
    description: Route destination.
  RoutingRuleListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/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.
  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: '#/definitions/RoutingRuleRouteDestination'
        description: Indicates the destination for this particular rule.
      nextHop:
        $ref: '#/definitions/RoutingRuleNextHop'
        description: Indicates the next hop for this particular rule.
    required:
    - destination
    - nextHop
    description: Routing routing rule resource.
  RoutingRule:
    type: object
    properties:
      properties:
        $ref: '#/definitions/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.
  RoutingRuleNextHopType:
    type: string
    description: Routing rule next hop type.
    enum:
    - Internet
    - NoNextNop
    - VirtualAppliance
    - VirtualNetworkGateway
    - VnetLocal
    x-ms-enum:
      name: RoutingRuleNextHopType
      modelAsString: true
parameters:
  RoutingConfigurationsRuleParameter:
    name: ruleName
    in: path
    description: The name of the rule.
    pattern: ^[a-zA-Z0-9_.-]*$
    required: true
    type: string
    x-ms-parameter-location: method
  RoutingConfigurationParameter:
    name: configurationName
    in: path
    description: The name of the network manager Routing Configuration.
    pattern: ^[a-zA-Z0-9_.-]*$
    required: true
    type: string
    x-ms-parameter-location: method
  NetworkManagerNameParameter:
    name: networkManagerName
    in: path
    required: true
    type: string
    description: The name of the network manager.
    pattern: ^[a-zA-Z0-9_.-]*$
    x-ms-parameter-location: method
  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
    type: integer
    format: int32
    minimum: 1
    maximum: 20
    x-ms-parameter-location: method
  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
    type: string
    x-ms-parameter-location: method
  RuleCollectionParameter:
    name: ruleCollectionName
    in: path
    description: The name of the network manager routing Configuration rule collection.
    pattern: ^[a-zA-Z0-9_.-]*$
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'