swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RoutingRuleCollections API
schemes:
- https
tags:
- name: RoutingRuleCollections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections
  : get:
      tags:
      - RoutingRuleCollections
      operationId: microsoftAzureRoutingrulecollectionsList
      description: Lists all the rule collections in a routing configuration, in a paginated format.
      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/ListTopParameter'
      - $ref: '#/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: Get successful. The operation returns all ruleCollections in the specified routing configuration, in a paginated format
          schema:
            $ref: '#/definitions/RoutingRuleCollectionListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List routing rule collections:
          $ref: ./examples/NetworkManagerRoutingRuleCollectionList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}
  : 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'
    get:
      tags:
      - RoutingRuleCollections
      description: Gets a network manager routing configuration rule collection.
      operationId: microsoftAzureRoutingrulecollectionsGet
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/RoutingRuleCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Gets routing rule collection:
          $ref: ./examples/NetworkManagerRoutingRuleCollectionGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname
    put:
      tags:
      - RoutingRuleCollections
      description: Creates or updates a routing rule collection.
      operationId: microsoftAzureRoutingrulecollectionsCreateorupdate
      parameters:
      - name: ruleCollection
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoutingRuleCollection'
        description: The Rule Collection to create or update
      responses:
        '200':
          description: Updated Rule Collection
          schema:
            $ref: '#/definitions/RoutingRuleCollection'
        '201':
          description: Created Rule Collection
          schema:
            $ref: '#/definitions/RoutingRuleCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Create or Update a routing rule collection:
          $ref: ./examples/NetworkManagerRoutingRuleCollectionPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname
    delete:
      tags:
      - RoutingRuleCollections
      description: Deletes an routing rule collection.
      operationId: microsoftAzureRoutingrulecollectionsDelete
      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 an routing rule collection:
          $ref: ./examples/NetworkManagerRoutingRuleCollectionDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Routingconfigurations Configurationname Rulecollections Rulecollectionname
definitions:
  RoutingRuleCollection:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RoutingRuleCollectionPropertiesFormat'
        description: Indicates the properties for the network manager routing rule collection.
      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: Defines the routing rule collection.
  RoutingRuleCollectionLocalRouteSetting:
    type: string
    description: Routing rule collection local route setting.
    enum:
    - NotSpecified
    - DirectRoutingWithinVNet
    - DirectRoutingWithinSubnet
    x-ms-enum:
      name: RoutingRuleCollectionLocalRouteSetting
      modelAsString: true
  RoutingRuleCollectionPropertiesFormat:
    type: object
    properties:
      description:
        type: string
        description: A description of the routing rule collection.
      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.
      appliesTo:
        type: array
        x-ms-identifiers:
        - networkGroupId
        items:
          $ref: '#/definitions/NetworkManagerRoutingGroupItem'
        description: Groups for configuration
      disableBgpRoutePropagation:
        type: boolean
        default: true
        description: Determines whether BGP route propagation is enabled. Defaults to true.
      localRouteSetting:
        $ref: '#/definitions/RoutingRuleCollectionLocalRouteSetting'
        description: Indicates local route setting for this particular rule collection.
    required:
    - appliesTo
    - localRouteSetting
    description: Defines the routing rule collection properties.
  RoutingRuleCollectionListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/RoutingRuleCollection'
        description: A list of network manager routing configuration rule collections
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Routing configuration rule collection list result.
  NetworkManagerRoutingGroupItem:
    type: object
    properties:
      networkGroupId:
        type: string
        description: Network manager group Id.
    required:
    - networkGroupId
    description: Network manager routing group item.
parameters:
  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'