azure.purview.scanning.rest.scans package¶

azure.purview.scanning.rest.scans.build_create_or_update_request(data_source_name: str, scan_name: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

Creates an instance 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) –

Keyword Arguments

json (Any) –
content (Any) –

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

# kind template as part of your input body
kind = 'AdlsGen1CredentialScan' or 'AdlsGen1MsiScan' or 'AdlsGen2CredentialScan' or 'AdlsGen2MsiScan' or 'AmazonAccountCredentialScan' or 'AmazonPostgreSqlCredentialScan' or 'AmazonS3CredentialScan' or 'AmazonS3RoleARNScan' or 'AmazonSqlCredentialScan' or 'AzureCosmosDbCredentialScan' or 'AzureDataExplorerCredentialScan' or 'AzureDataExplorerMsiScan' or 'AzureFileServiceCredentialScan' or 'AzureMySqlCredentialScan' or 'AzurePostgreSqlCredentialScan' or 'AzureResourceGroupCredentialScan' or 'AzureResourceGroupMsiScan' or 'AzureSqlDataWarehouseCredentialScan' or 'AzureSqlDataWarehouseMsiScan' or 'AzureSqlDatabaseCredentialScan' or 'AzureSqlDatabaseManagedInstanceCredentialScan' or 'AzureSqlDatabaseManagedInstanceMsiScan' or 'AzureSqlDatabaseMsiScan' or 'AzureStorageCredentialScan' or 'AzureStorageMsiScan' or 'AzureSubscriptionCredentialScan' or 'AzureSubscriptionMsiScan' or 'AzureSynapseCredentialScan' or 'AzureSynapseMsiScan' or 'AzureSynapseWorkspaceCredentialScan' or 'AzureSynapseWorkspaceMsiScan' or 'OracleCredentialScan' or 'OracleUserPassScan' or 'PowerBIDelegatedScan' or 'PowerBIMsiScan' or 'SapEccCredentialScan' or 'SapEccUserPassScan' or 'SapS4HanaSapS4HanaCredentialScan' or 'SapS4HanaSapS4HanaUserPassScan' or 'SqlServerDatabaseCredentialScan' or 'TeradataCredentialScan' or 'TeradataUserPassScanAutoGenerated' or 'TeradataUserPassScan'

# JSON input template you can fill out and use as your `json` input.
json = {
    "kind": "Scan",
    "scanResults": [
        {
            "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)"
        }
    ]
}


# response body for status code(s): 200, 201
response_body == {
    "kind": "Scan",
    "scanResults": [
        {
            "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)"
        }
    ]
}

azure.purview.scanning.rest.scans.build_get_request(data_source_name: str, scan_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

Gets a scan information.

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 == {
    "kind": "Scan",
    "scanResults": [
        {
            "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)"
        }
    ]
}

azure.purview.scanning.rest.scans.build_delete_request(data_source_name: str, scan_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

Deletes the scan associated with the data source.

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 == {
    "kind": "Scan",
    "scanResults": [
        {
            "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)"
        }
    ]
}

azure.purview.scanning.rest.scans.build_list_by_data_source_request(data_source_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

List scans in data source.

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

Parameters: data_source_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": [
        {
            "kind": "Scan",
            "scanResults": [
                {
                    "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)"
                }
            ]
        }
    ]
}