putScan.md

pv scan putScan

Command Reference > scan > putScan

Description

Creates an instance of a scan

Syntax

pv scan putScan --dataSourceName=<val> --scanName=<val> --payloadFile=<val>

Required Arguments

--dataSourceName (string)
The data source name.

--scanName (string)
The scan name.

--payloadFile (string)
File path to a valid JSON document.

Optional Arguments

None

API Mapping

Scanning Data Plane > Scans > Create Or Update

PUT https://{accountName}.purview.azure.com/scan/datasources/{dataSourceName}/scans/{scanName}

Examples

Create a scan.

pv scan putScan --dataSourceName "AzureDataLakeStorage-Gbm" --scanName "Scan-ABC" --payloadFile "/path/to/file.json"

Example payload.

{
    "kind": "AdlsGen2Msi",
    "name": "Scan-ABC",
    "properties": {
        "collection": {
            "referenceName": "esg-26fa7f24-pv",
            "type": "CollectionReference"
        },
        "scanRulesetName": "AdlsGen2",
        "scanRulesetType": "System"
    }
}