azure.purview.scanning.rest.scan_result package

azure.purview.scanning.rest.scan_result.build_run_scan_request(data_source_name: str, scan_name: str, run_id: str, *, scan_level: Union[str, _models.ScanLevelType, None] = None, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest

Runs the scan.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

• data_source_name (str) –

• scan_name (str) –

• run_id (str) –

Keyword Arguments

scan_level (str or ScanLevelType) –

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 202
response_body == {
    "endTime": "datetime (optional)",
    "error": {},
    "scanResultId": "str (optional)",
    "startTime": "datetime (optional)",
    "status": "str (optional)"
}

azure.purview.scanning.rest.scan_result.build_cancel_scan_request(data_source_name: str, scan_name: str, run_id: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest

Cancels a scan.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

• data_source_name (str) –

• scan_name (str) –

• run_id (str) –

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 202
response_body == {
    "endTime": "datetime (optional)",
    "error": {},
    "scanResultId": "str (optional)",
    "startTime": "datetime (optional)",
    "status": "str (optional)"
}

azure.purview.scanning.rest.scan_result.build_list_scan_history_request(data_source_name: str, scan_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest

Lists the scan history of a scan.

See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this request builder into your code flow.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

Returns an HttpRequest that you will pass to the client’s send_request method. See https://aka.ms/azsdk/python/protocol/quickstart for how to incorporate this response into your code flow.

Return type

HttpRequest

Example

# response body for status code(s): 200
response_body == {
    "count": "long (optional)",
    "nextLink": "str (optional)",
    "value": [
        {
            "assetsClassified": "long (optional)",
            "assetsDiscovered": "long (optional)",
            "dataSourceType": "str (optional)",
            "diagnostics": {},
            "endTime": "datetime (optional)",
            "error": {},
            "errorMessage": "str (optional)",
            "id": "str (optional)",
            "parentId": "str (optional)",
            "pipelineStartTime": "datetime (optional)",
            "queuedTime": "datetime (optional)",
            "resourceId": "str (optional)",
            "runType": "str (optional)",
            "scanLevelType": "str (optional)",
            "scanRulesetType": "str (optional)",
            "scanRulesetVersion": "int (optional)",
            "startTime": "datetime (optional)",
            "status": "str (optional)"
        }
    ]
}