swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ClassificationRules API
schemes:
- https
tags:
- name: ClassificationRules
paths:
  /classificationrules/{classificationRuleName}:
    get:
      tags:
      - ClassificationRules
      description: Get a classification rule
      operationId: microsoftAzureClassificationrulesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: classificationRuleName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ClassificationRule'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ClassificationRules_Get:
          $ref: ./examples/ClassificationRules_Get.json
      summary: Microsoft Azure Get Classificationrules Classificationrulename
    put:
      tags:
      - ClassificationRules
      description: Creates or Updates a classification rule
      operationId: microsoftAzureClassificationrulesCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: classificationRuleName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        schema:
          $ref: '#/definitions/ClassificationRule'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ClassificationRule'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/ClassificationRule'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ClassificationRules_CreateOrUpdate:
          $ref: ./examples/ClassificationRules_CreateOrUpdate.json
      summary: Microsoft Azure Put Classificationrules Classificationrulename
    delete:
      tags:
      - ClassificationRules
      description: Deletes a classification rule
      operationId: microsoftAzureClassificationrulesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: classificationRuleName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ClassificationRule'
        '204':
          description: Success
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ClassificationRules_Delete:
          $ref: ./examples/ClassificationRules_Delete.json
      summary: Microsoft Azure Delete Classificationrules Classificationrulename
  /classificationrules:
    get:
      tags:
      - ClassificationRules
      description: List classification rules in Account
      operationId: microsoftAzureClassificationrulesListall
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ClassificationRuleList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ClassificationRules_ListAll:
          $ref: ./examples/ClassificationRules_ListAll.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Classificationrules
  /classificationrules/{classificationRuleName}/versions:
    get:
      tags:
      - ClassificationRules
      description: Lists the rule versions of a classification rule
      operationId: microsoftAzureClassificationrulesListversionsbyclassificationrulename
      produces:
      - application/json
      parameters:
      - in: path
        name: classificationRuleName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ClassificationRuleList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ClassificationRules_ListVersionsByClassificationRuleName:
          $ref: ./examples/ClassificationRules_ListVersionsByClassificationRuleName.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Classificationrules Classificationrulename Versions
  /classificationrules/{classificationRuleName}/versions/{classificationRuleVersion}/:tag:
    post:
      tags:
      - ClassificationRules
      description: Sets Classification Action on a specific classification rule version.
      operationId: microsoftAzureClassificationrulesTagclassificationversion
      produces:
      - application/json
      parameters:
      - in: path
        name: classificationRuleName
        required: true
        type: string
      - in: path
        name: classificationRuleVersion
        required: true
        type: integer
        format: int32
      - in: query
        name: action
        required: true
        type: string
        enum:
        - Keep
        - Delete
        x-ms-enum:
          name: ClassificationAction
          modelAsString: true
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/OperationResponse'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ClassificationRules_TagClassificationVersion:
          $ref: ./examples/ClassificationRules_TagClassificationVersion.json
      summary: Microsoft Azure Post Classificationrules Classificationrulename Versions Classificationruleversion :tag
definitions:
  ClassificationRule:
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      kind:
        enum:
        - System
        - Custom
        type: string
        x-ms-enum:
          name: ClassificationRuleType
          modelAsString: true
    discriminator: kind
  ProxyResource:
    type: object
    properties:
      id:
        type: string
        readOnly: true
      name:
        type: string
        readOnly: true
  ErrorInfo:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorInfo'
  ErrorResponseModel:
    type: object
    properties:
      error:
        allOf:
        - $ref: '#/definitions/ErrorModel'
  ErrorModel:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
  ClassificationRuleList:
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ClassificationRule'
      nextLink:
        type: string
      count:
        format: int64
        type: integer
  OperationResponse:
    type: object
    properties:
      scanResultId:
        format: uuid
        type: string
      startTime:
        format: date-time
        type: string
      endTime:
        format: date-time
        type: string
      status:
        enum:
        - Accepted
        - InProgress
        - TransientFailure
        - Succeeded
        - Failed
        - Canceled
        type: string
        x-ms-enum:
          name: OperationStatus
          modelAsString: true
      error:
        allOf:
        - $ref: '#/definitions/ErrorInfo'
parameters:
  api-version:
    in: query
    name: api-version
    description: The api version to use.
    required: true
    type: string
    x-ms-client-name: ApiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'