ScanResultOperations Class

ScanResultOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ScanResultOperations

Constructor

ScanResultOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Methods

cancel_scan	Cancels a scan.
list_scan_history	Lists the scan history of a scan.
run_scan	Runs the scan.

cancel_scan

Cancels a scan.

cancel_scan(data_source_name: str, scan_name: str, run_id: str, **kwargs: Any) -> Any

Parameters

data_source_name

str

Required

scan_name

str

Required

run_id

str

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 202
   response.json() == {
       "endTime": "2020-02-20 00:00:00",  # Optional.
       "error": {
           "code": "str",  # Optional.
           "details": [
               {
                   "code": "str",  # Optional.
                   "details": [
                       ...
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               }
           ],
           "message": "str",  # Optional.
           "target": "str"  # Optional.
       },
       "scanResultId": str,  # Optional.
       "startTime": "2020-02-20 00:00:00",  # Optional.
       "status": "str"  # Optional. Possible values include: "Accepted", "InProgress", "TransientFailure", "Succeeded", "Failed", "Canceled".
   }

list_scan_history

Lists the scan history of a scan.

list_scan_history(data_source_name: str, scan_name: str, **kwargs: Any) -> Iterable[Any]

Parameters

data_source_name

str

Required

scan_name

str

Required

Returns

An iterator like instance of JSON object

Return type

ItemPaged[<xref:Any>]

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "count": 0.0,  # Optional.
       "nextLink": "str",  # Optional.
       "value": [
           {
               "assetsClassified": 0.0,  # Optional.
               "assetsDiscovered": 0.0,  # Optional.
               "dataSourceType": "str",  # Optional. Possible values include: "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".
               "diagnostics": {
                   "exceptionCountMap": {
                       "str": 0  # Optional. Dictionary of :code:`<integer>`.
                   },
                   "notifications": [
                       {
                           "code": 0,  # Optional.
                           "message": "str"  # Optional.
                       }
                   ]
               },
               "endTime": "2020-02-20 00:00:00",  # Optional.
               "error": {
                   "code": "str",  # Optional.
                   "details": [
                       {
                           "code": "str",  # Optional.
                           "details": [
                               ...
                           ],
                           "message": "str",  # Optional.
                           "target": "str"  # Optional.
                       }
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               },
               "errorMessage": "str",  # Optional.
               "id": "str",  # Optional.
               "parentId": "str",  # Optional.
               "pipelineStartTime": "2020-02-20 00:00:00",  # Optional.
               "queuedTime": "2020-02-20 00:00:00",  # Optional.
               "resourceId": "str",  # Optional.
               "runType": "str",  # Optional.
               "scanLevelType": "str",  # Optional. Possible values include: "Full", "Incremental".
               "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
               "scanRulesetVersion": 0,  # Optional.
               "startTime": "2020-02-20 00:00:00",  # Optional.
               "status": "str"  # Optional.
           }
       ]
   }

run_scan

Runs the scan.

run_scan(data_source_name: str, scan_name: str, run_id: str, **kwargs: Any) -> Any

Parameters

data_source_name

str

Required

scan_name

str

Required

run_id

str

Required

scan_level

str

Possible values are: "Full" or "Incremental".

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 202
   response.json() == {
       "endTime": "2020-02-20 00:00:00",  # Optional.
       "error": {
           "code": "str",  # Optional.
           "details": [
               {
                   "code": "str",  # Optional.
                   "details": [
                       ...
                   ],
                   "message": "str",  # Optional.
                   "target": "str"  # Optional.
               }
           ],
           "message": "str",  # Optional.
           "target": "str"  # Optional.
       },
       "scanResultId": str,  # Optional.
       "startTime": "2020-02-20 00:00:00",  # Optional.
       "status": "str"  # Optional. Possible values include: "Accepted", "InProgress", "TransientFailure", "Succeeded", "Failed", "Canceled".
   }