swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector UserRules API
schemes:
- https
tags:
- name: UserRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules
  : parameters:
    - $ref: ./network.json#/parameters/ApiVersionParameter
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/NetworkManagerNameParameter'
    - $ref: '#/parameters/SecurityConfigurationParameter'
    - $ref: '#/parameters/RuleCollectionParameter'
    - $ref: '#/parameters/ListTopParameter'
    - $ref: '#/parameters/ListSkipTokenParameter'
    get:
      tags:
      - UserRules
      description: Lists all user rules in a rule collection.
      operationId: microsoftAzureUserrulesList
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/UserRuleListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        List security user rules:
          $ref: ./examples/NetworkManagerUserRuleList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections Rulecollectionname Rules
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
  : parameters:
    - $ref: ./network.json#/parameters/ApiVersionParameter
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/NetworkManagerNameParameter'
    - $ref: '#/parameters/SecurityConfigurationParameter'
    - $ref: '#/parameters/RuleCollectionParameter'
    - $ref: '#/parameters/SecurityConfigurationsRuleParameter'
    get:
      tags:
      - UserRules
      description: Gets a user rule.
      operationId: microsoftAzureUserrulesGet
      responses:
        '200':
          description: Successful operation
          schema:
            $ref: '#/definitions/BaseUserRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Gets a user rule:
          $ref: ./examples/NetworkManagerUserRuleGet.json
        Gets a default user rule:
          $ref: ./examples/NetworkManagerDefaultUserRuleGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
    put:
      tags:
      - UserRules
      description: Creates or updates a user rule.
      operationId: microsoftAzureUserrulesCreateorupdate
      parameters:
      - name: userRule
        in: body
        required: true
        schema:
          $ref: '#/definitions/BaseUserRule'
        description: The user rule to create or update
      responses:
        '200':
          description: Updated rule
          schema:
            $ref: '#/definitions/BaseUserRule'
        '201':
          description: Created rule
          schema:
            $ref: '#/definitions/BaseUserRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        Create a user rule:
          $ref: ./examples/NetworkManagerUserRulePut.json
        Create a default user rule:
          $ref: ./examples/NetworkManagerDefaultUserRulePut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
    delete:
      tags:
      - UserRules
      description: Deletes a user rule.
      operationId: microsoftAzureUserrulesDelete
      parameters:
      - $ref: '#/parameters/ForceDeleteParameter'
      responses:
        '200':
          description: Delete Succeed.
        '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:
        Delete a user rule:
          $ref: ./examples/NetworkManagerUserRuleDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Securityuserconfigurations Configurationname Rulecollections Rulecollectionname Rules Rulename
definitions:
  BaseUserRule:
    type: object
    properties:
      kind:
        type: string
        description: Whether the rule is custom or default.
        enum:
        - Custom
        - Default
        x-ms-enum:
          name: UserRuleKind
          modelAsString: true
      systemData:
        readOnly: true
        description: The system metadata related to this resource.
        $ref: ./network.json#/definitions/SystemData
    allOf:
    - $ref: ./network.json#/definitions/ProxyResource
    required:
    - kind
    discriminator: kind
    description: Network base rule.
  UserRuleListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/BaseUserRule'
        description: A list of user rules
      nextLink:
        type: string
        description: The URL to get the next set of results.
    description: security user rule 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
  SecurityConfigurationsRuleParameter:
    name: ruleName
    in: path
    description: The name of the rule.
    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.
    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'