swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Scan API
schemes:
- https
tags:
- name: Scan
paths:
  /datasources/{dataSourceName}/scans/{scanName}:
    put:
      tags:
      - Scan
      description: Creates an instance of a scan
      operationId: microsoftAzureScansCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - in: path
        name: scanName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/Scan'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Scan'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Scan'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Scans_CreateOrUpdate:
          $ref: ./examples/Scans_CreateOrUpdate.json
      summary: Microsoft Azure Put Datasources Datasourcename Scans Scanname
    get:
      tags:
      - Scan
      description: Gets a scan information
      operationId: microsoftAzureScansGet
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - in: path
        name: scanName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Scan'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Scans_Get:
          $ref: ./examples/Scans_Get.json
      summary: Microsoft Azure Get Datasources Datasourcename Scans Scanname
    delete:
      tags:
      - Scan
      description: Deletes the scan associated with the data source
      operationId: microsoftAzureScansDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - in: path
        name: scanName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Scan'
        '204':
          description: Success
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Scans_Delete:
          $ref: ./examples/Scans_Delete.json
      summary: Microsoft Azure Delete Datasources Datasourcename Scans Scanname
  /datasources/{dataSourceName}/scans:
    get:
      tags:
      - Scan
      description: List scans in data source
      operationId: microsoftAzureScansListbydatasource
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScanList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Scans_ListByDataSource:
          $ref: ./examples/Scans_ListByDataSource.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Datasources Datasourcename Scans
definitions:
  ProxyResource:
    type: object
    properties:
      id:
        type: string
        readOnly: true
      name:
        type: string
        readOnly: true
  Scan:
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      kind:
        enum:
        - AzureSubscriptionCredential
        - AzureSubscriptionMsi
        - AzureResourceGroupCredential
        - AzureResourceGroupMsi
        - AzureSynapseWorkspaceCredential
        - AzureSynapseWorkspaceMsi
        - AzureSynapseCredential
        - AzureSynapseMsi
        - AdlsGen1Credential
        - AdlsGen1Msi
        - AdlsGen2Credential
        - AdlsGen2Msi
        - AmazonAccountCredential
        - AmazonS3Credential
        - AmazonS3RoleARN
        - AmazonSqlCredential
        - AzureCosmosDbCredential
        - AzureDataExplorerCredential
        - AzureDataExplorerMsi
        - AzureFileServiceCredential
        - AzureSqlDatabaseCredential
        - AzureSqlDatabaseMsi
        - AmazonPostgreSqlCredential
        - AzurePostgreSqlCredential
        - SqlServerDatabaseCredential
        - AzureSqlDatabaseManagedInstanceCredential
        - AzureSqlDatabaseManagedInstanceMsi
        - AzureSqlDataWarehouseCredential
        - AzureSqlDataWarehouseMsi
        - AzureMySqlCredential
        - AzureStorageCredential
        - AzureStorageMsi
        - TeradataTeradataCredential
        - TeradataTeradataUserPass
        - TeradataUserPass
        - OracleOracleCredential
        - OracleOracleUserPass
        - SapS4HanaSapS4HanaCredential
        - SapS4HanaSapS4HanaUserPass
        - SapEccSapEccCredential
        - SapEccSapEccUserPass
        - PowerBIDelegated
        - PowerBIMsi
        type: string
        x-ms-enum:
          name: ScanAuthorizationType
          modelAsString: true
      scanResults:
        type: array
        items:
          $ref: '#/definitions/ScanResult'
        readOnly: true
    discriminator: kind
  ScanDiagnostics:
    type: object
    properties:
      notifications:
        type: array
        items:
          $ref: '#/definitions/Notification'
      exceptionCountMap:
        type: object
        additionalProperties:
          format: int32
          type: integer
        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'
  Notification:
    type: object
    properties:
      message:
        type: string
      code:
        format: int32
        type: integer
  ScanList:
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Scan'
      nextLink:
        type: string
      count:
        format: int64
        type: integer
  ScanResult:
    type: object
    properties:
      parentId:
        type: string
        readOnly: true
      id:
        type: string
        readOnly: true
      resourceId:
        type: string
        readOnly: true
      status:
        type: string
        readOnly: true
      assetsDiscovered:
        format: int64
        type: integer
        readOnly: true
      assetsClassified:
        format: int64
        type: integer
        readOnly: true
      diagnostics:
        allOf:
        - $ref: '#/definitions/ScanDiagnostics'
        readOnly: true
      startTime:
        format: date-time
        type: string
        readOnly: true
      queuedTime:
        format: date-time
        type: string
        readOnly: true
      pipelineStartTime:
        format: date-time
        type: string
        readOnly: true
      endTime:
        format: date-time
        type: string
        readOnly: true
      scanRulesetVersion:
        format: int32
        type: integer
        readOnly: true
      scanRulesetType:
        enum:
        - Custom
        - System
        type: string
        readOnly: true
        x-ms-enum:
          name: ScanRulesetType
          modelAsString: true
      scanLevelType:
        enum:
        - Full
        - Incremental
        type: string
        readOnly: true
        x-ms-enum:
          name: ScanLevelType
          modelAsString: true
      errorMessage:
        type: string
        readOnly: true
      error:
        allOf:
        - $ref: '#/definitions/ErrorModel'
        readOnly: true
      runType:
        type: string
        readOnly: true
      dataSourceType:
        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
        readOnly: true
        x-ms-enum:
          name: DataSourceType
          modelAsString: 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'