Scan Result - Run Scan

Runs the scan

PUT {Endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}?api-version=2022-02-01-preview
PUT {Endpoint}/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}?scanLevel={scanLevel}&api-version=2022-02-01-preview

URI Parameters

Name In Required Type Description
dataSourceName
path True
  • string
Endpoint
path True
  • string

The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com

runId
path True
  • string
scanName
path True
  • string
api-version
query True
  • string

The api version to use.

scanLevel
query

Responses

Name Type Description
202 Accepted

Success

Other Status Codes

An error response received from the Scanning Service

Examples

ScanResult_RunScan

Sample Request

PUT {Endpoint}/scan/datasources/testDataSourceName/scans/scan1/runs/138301e4-f4f9-4ab5-b734-bac446b236e7?scanLevel=Full&api-version=2022-02-01-preview

Sample Response

x-ms-request-id: 00000000-0000-0000-0000-00000000000
{
  "scanResultId": "138301e4-f4f9-4ab5-b734-bac446b236e7",
  "startTime": "2019-05-16T17:01:37.3089193Z",
  "endTime": null,
  "status": "Accepted",
  "error": null
}

Definitions

Error
ErrorModel
ErrorResponseModel
OperationResponse
OperationStatus
ScanLevelType

Error

Name Type Description
code
  • string
details
message
  • string
target
  • string

ErrorModel

Name Type Description
code
  • string
details
message
  • string
target
  • string

ErrorResponseModel

Name Type Description
error

OperationResponse

Name Type Description
endTime
  • string
error
scanResultId
  • string
startTime
  • string
status

OperationStatus

Name Type Description
Accepted
  • string
Canceled
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string
TransientFailure
  • string

ScanLevelType

Name Type Description
Full
  • string
Incremental
  • string