Microsoft Purview Scanning API — Scan Result

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Scanning API — Scan Result
  description: 'Microsoft Purview Scanning API — Scan Result. 3 operations. Lead operation: Microsoft Purview List scan history.
    Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Scan Result
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_PURVIEW_API_KEY: MICROSOFT_PURVIEW_API_KEY
capability:
  consumes:
  - type: http
    namespace: scanning-scan-result
    baseUri: https://{accountName}.scan.purview.azure.com
    description: Microsoft Purview Scanning API — Scan Result business capability. Self-contained, no shared references.
    resources:
    - name: scan-datasources-dataSourceName-scans-scanName-runs
      path: /scan/datasources/{dataSourceName}/scans/{scanName}/runs
      operations:
      - name: listscanhistory
        method: GET
        description: Microsoft Purview List scan history
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSourceName
          in: path
          type: string
          required: true
        - name: scanName
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    - name: scan-datasources-dataSourceName-scans-scanName-runs-runId
      path: /scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}
      operations:
      - name: runscan
        method: PUT
        description: Microsoft Purview Run a scan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSourceName
          in: path
          type: string
          required: true
        - name: scanName
          in: path
          type: string
          required: true
        - name: runId
          in: path
          type: string
          description: The unique identifier for the scan run
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: scanLevel
          in: query
          type: string
          description: The level of scan (Full or Incremental)
    - name: scan-datasources-dataSourceName-scans-scanName-runs-runId-:cancel
      path: /scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}/:cancel
      operations:
      - name: cancelscan
        method: POST
        description: Microsoft Purview Cancel a scan run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSourceName
          in: path
          type: string
          required: true
        - name: scanName
          in: path
          type: string
          required: true
        - name: runId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: scanning-scan-result-rest
    port: 8080
    description: REST adapter for Microsoft Purview Scanning API — Scan Result. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/scan/datasources/{datasourcename}/scans/{scanname}/runs
      name: scan-datasources-datasourcename-scans-scanname-runs
      description: REST surface for scan-datasources-dataSourceName-scans-scanName-runs.
      operations:
      - method: GET
        name: listscanhistory
        description: Microsoft Purview List scan history
        call: scanning-scan-result.listscanhistory
        with:
          dataSourceName: rest.dataSourceName
          scanName: rest.scanName
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scan/datasources/{datasourcename}/scans/{scanname}/runs/{runid}
      name: scan-datasources-datasourcename-scans-scanname-runs-runid
      description: REST surface for scan-datasources-dataSourceName-scans-scanName-runs-runId.
      operations:
      - method: PUT
        name: runscan
        description: Microsoft Purview Run a scan
        call: scanning-scan-result.runscan
        with:
          dataSourceName: rest.dataSourceName
          scanName: rest.scanName
          runId: rest.runId
          api-version: rest.api-version
          scanLevel: rest.scanLevel
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scan/datasources/{datasourcename}/scans/{scanname}/runs/{runid}/cancel
      name: scan-datasources-datasourcename-scans-scanname-runs-runid-cancel
      description: REST surface for scan-datasources-dataSourceName-scans-scanName-runs-runId-:cancel.
      operations:
      - method: POST
        name: cancelscan
        description: Microsoft Purview Cancel a scan run
        call: scanning-scan-result.cancelscan
        with:
          dataSourceName: rest.dataSourceName
          scanName: rest.scanName
          runId: rest.runId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: scanning-scan-result-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Scanning API — Scan Result. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: microsoft-purview-list-scan-history
      description: Microsoft Purview List scan history
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: scanning-scan-result.listscanhistory
      with:
        dataSourceName: tools.dataSourceName
        scanName: tools.scanName
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-run-scan
      description: Microsoft Purview Run a scan
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: scanning-scan-result.runscan
      with:
        dataSourceName: tools.dataSourceName
        scanName: tools.scanName
        runId: tools.runId
        api-version: tools.api-version
        scanLevel: tools.scanLevel
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-cancel-scan-run
      description: Microsoft Purview Cancel a scan run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: scanning-scan-result.cancelscan
      with:
        dataSourceName: tools.dataSourceName
        scanName: tools.scanName
        runId: tools.runId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.