swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector UserRuleCollections API
schemes:
- https
tags:
- name: UserRuleCollections
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections
  : get:
      tags:
      - UserRuleCollections
      operationId: microsoftAzureUserrulecollectionsList
      description: Lists all the user rule collections in a security configuration, in a paginated format.
      parameters:
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/NetworkManagerNameParameter'
      - $ref: '#/parameters/SecurityConfigurationParameter'
      - $ref: '#/parameters/ListTopParameter'
      - $ref: '#/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: Get successful. The operation returns all ruleCollections in the specified security configuration, in a paginated format
          schema:
            $ref: '#/definitions/UserRuleCollectionListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List rule collections in a security configuration:
          $ref: ./examples/NetworkManagerUserRuleCollectionList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}
  : parameters:
    - $ref: ./network.json#/parameters/ApiVersionParameter
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/NetworkManagerNameParameter'
    - $ref: '#/parameters/SecurityConfigurationParameter'
    - $ref: '#/parameters/RuleCollectionParameter'
    put:
      tags:
      - UserRuleCollections
      description: Creates or updates a user rule collection.
      operationId: microsoftAzureUserrulecollectionsCreateorupdate
      parameters:
      - name: userRuleCollection
        in: body
        required: true
        schema:
          $ref: '#/definitions/UserRuleCollection'
        description: The User Rule Collection to create or update
      responses:
        '200':
          description: Updated User Rule Collection
          schema:
            $ref: '#/definitions/UserRuleCollection'
        '201':
          description: Created User Rule Collection
          schema:
            $ref: '#/definitions/UserRuleCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Create or Update a User Rule Collection:
          $ref: ./examples/NetworkManagerUserRuleCollectionPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections Rulecollectionname
    delete:
      tags:
      - UserRuleCollections
      description: Deletes a user rule collection.
      parameters:
      - $ref: '#/parameters/ForceDeleteParameter'
      operationId: microsoftAzureUserrulecollectionsDelete
      responses:
        '200':
          description: OK
        '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-examples:
        Deletes a user rule collection:
          $ref: ./examples/NetworkManagerUserRuleCollectionDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections Rulecollectionname
definitions:
  UserRuleCollection:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/UserRuleCollectionPropertiesFormat'
        description: Indicates the properties for the network manager user rule collection.
      systemData:
        readOnly: true
        description: The system metadata related to this resource.
        $ref: ./network.json#/definitions/SystemData
    allOf:
    - $ref: ./network.json#/definitions/ProxyResource
    description: Defines the user rule collection.
  UserRuleCollectionPropertiesFormat:
    type: object
    properties:
      description:
        type: string
        description: A description of the user rule collection.
      appliesToGroups:
        type: array
        x-ms-identifiers:
        - networkGroupId
        items:
          $ref: ./networkManagerSecurityAdminConfiguration.json#/definitions/NetworkManagerSecurityGroupItem
        description: Groups for configuration
      provisioningState:
        readOnly: true
        $ref: ./network.json#/definitions/ProvisioningState
        description: The provisioning state of the resource.
    required:
    - appliesToGroups
    description: Defines the user rule collection properties.
  UserRuleCollectionListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/UserRuleCollection'
        description: A list of network manager security user configuration rule collections
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Security user configuration rule collection list result.
parameters:
  ForceDeleteParameter:
    name: force
    in: query
    required: false
    type: boolean
    description: Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.
    x-ms-parameter-location: method
  NetworkManagerNameParameter:
    name: networkManagerName
    in: path
    required: true
    type: string
    description: The name of the network manager.
    x-ms-parameter-location: method
  SecurityConfigurationParameter:
    name: configurationName
    in: path
    description: The name of the network manager Security Configuration.
    required: true
    type: string
    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
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
  RuleCollectionParameter:
    name: ruleCollectionName
    in: path
    description: The name of the network manager security Configuration rule collection.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'