swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ScanRulesets API
schemes:
- https
tags:
- name: ScanRulesets
paths:
  /scanrulesets/{scanRulesetName}:
    get:
      tags:
      - ScanRulesets
      description: Get a scan ruleset
      operationId: microsoftAzureScanrulesetsGet
      produces:
      - application/json
      parameters:
      - in: path
        name: scanRulesetName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScanRuleset'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ScanRulesets_Get:
          $ref: ./examples/ScanRulesets_Get.json
      summary: Microsoft Azure Get Scanrulesets Scanrulesetname
    put:
      tags:
      - ScanRulesets
      description: Creates or Updates a scan ruleset
      operationId: microsoftAzureScanrulesetsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: scanRulesetName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        schema:
          $ref: '#/definitions/ScanRuleset'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScanRuleset'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/ScanRuleset'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ScanRulesets_CreateOrUpdate:
          $ref: ./examples/ScanRulesets_CreateOrUpdate.json
      summary: Microsoft Azure Put Scanrulesets Scanrulesetname
    delete:
      tags:
      - ScanRulesets
      description: Deletes a scan ruleset
      operationId: microsoftAzureScanrulesetsDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: scanRulesetName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScanRuleset'
        '204':
          description: Success
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ScanRulesets_Delete:
          $ref: ./examples/ScanRulesets_Delete.json
      summary: Microsoft Azure Delete Scanrulesets Scanrulesetname
  /scanrulesets:
    get:
      tags:
      - ScanRulesets
      description: List scan rulesets in Data catalog
      operationId: microsoftAzureScanrulesetsListall
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScanRulesetList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        ScanRulesets_ListAll:
          $ref: ./examples/ScanRulesets_ListAll.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Scanrulesets
definitions:
  ScanRulesetList:
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ScanRuleset'
      nextLink:
        type: string
      count:
        format: int64
        type: integer
  ProxyResource:
    type: object
    properties:
      id:
        type: string
        readOnly: true
      name:
        type: string
        readOnly: true
  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'
  ScanRuleset:
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/VersionedScanRuleset'
    properties:
      kind:
        enum:
        - None
        - AzureSubscription
        - AzureResourceGroup
        - AzureSynapseWorkspace
        - AzureSynapse
        - AdlsGen1
        - AdlsGen2
        - AmazonAccount
        - AmazonS3
        - AmazonSql
        - AzureCosmosDb
        - AzureDataExplorer
        - AzureFileService
        - AzureSqlDatabase
        - AmazonPostgreSql
        - AzurePostgreSql
        - SqlServerDatabase
        - AzureSqlDatabaseManagedInstance
        - AzureSqlDataWarehouse
        - AzureMySql
        - AzureStorage
        - Teradata
        - Oracle
        - SapS4Hana
        - SapEcc
        - PowerBI
        type: string
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
    discriminator: kind
  VersionedScanRuleset:
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      scanRulesetType:
        enum:
        - Custom
        - System
        type: string
        x-ms-enum:
          name: ScanRulesetType
          modelAsString: true
      status:
        enum:
        - Enabled
        - Disabled
        type: string
        readOnly: true
        x-ms-enum:
          name: ScanRulesetStatus
          modelAsString: true
      version:
        format: int32
        type: integer
        readOnly: true
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'