swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SystemScanRulesets API
schemes:
- https
tags:
- name: SystemScanRulesets
paths:
  /systemScanRulesets:
    get:
      tags:
      - SystemScanRulesets
      description: List all system scan rulesets for an account
      operationId: microsoftAzureSystemscanrulesetsListall
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SystemScanRulesetList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        SystemScanRulesets_ListAll:
          $ref: ./examples/SystemScanRulesets_ListAll.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Systemscanrulesets
  /systemScanRulesets/datasources/{dataSourceType}:
    get:
      tags:
      - SystemScanRulesets
      description: Get a system scan ruleset for a data source
      operationId: microsoftAzureSystemscanrulesetsGet
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceType
        required: true
        type: string
        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
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SystemScanRuleset'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        SystemScanRulesets_Get:
          $ref: ./examples/SystemScanRulesets_Get.json
      summary: Microsoft Azure Get Systemscanrulesets Datasources Datasourcetype
  /systemScanRulesets/versions/{version}:
    get:
      tags:
      - SystemScanRulesets
      description: Get a scan ruleset by version
      operationId: microsoftAzureSystemscanrulesetsGetbyversion
      produces:
      - application/json
      parameters:
      - in: query
        name: dataSourceType
        type: string
        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
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
      - in: path
        name: version
        required: true
        type: integer
        format: int32
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SystemScanRuleset'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        SystemScanRulesets_GetByVersion:
          $ref: ./examples/SystemScanRulesets_GetByVersion.json
      summary: Microsoft Azure Get Systemscanrulesets Versions Version
  /systemScanRulesets/versions/latest:
    get:
      tags:
      - SystemScanRulesets
      description: Get the latest version of a system scan ruleset
      operationId: microsoftAzureSystemscanrulesetsGetlatest
      produces:
      - application/json
      parameters:
      - in: query
        name: dataSourceType
        type: string
        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
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SystemScanRuleset'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        SystemScanRulesets_GetLatest:
          $ref: ./examples/SystemScanRulesets_GetLatest.json
      summary: Microsoft Azure Get Systemscanrulesets Versions Latest
  /systemScanRulesets/versions:
    get:
      tags:
      - SystemScanRulesets
      description: List system scan ruleset versions in Data catalog
      operationId: microsoftAzureSystemscanrulesetsListversionsbydatasource
      produces:
      - application/json
      parameters:
      - in: query
        name: dataSourceType
        type: string
        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
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SystemScanRulesetList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        SystemScanRulesets_ListVersionsByDataSource:
          $ref: ./examples/SystemScanRulesets_ListVersionsByDataSource.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Systemscanrulesets Versions
definitions:
  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'
  SystemScanRulesetList:
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SystemScanRuleset'
      nextLink:
        type: string
      count:
        format: int64
        type: integer
  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
  SystemScanRuleset:
    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
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'