azure.purview.scanning.rest.data_sources package¶

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

Creates or Updates a 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) –

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 = 'AdlsGen1DataSource' or 'AdlsGen2DataSource' or 'AmazonAccountDataSource' or 'AmazonPostgreSqlDataSource' or 'AmazonS3DataSource' or 'AmazonSqlDataSource' or 'AzureCosmosDbDataSource' or 'AzureDataExplorerDataSource' or 'AzureFileServiceDataSource' or 'AzureMySqlDataSource' or 'AzurePostgreSqlDataSource' or 'AzureResourceGroupDataSource' or 'AzureSqlDataWarehouseDataSource' or 'AzureSqlDatabaseDataSource' or 'AzureSqlDatabaseManagedInstanceDataSource' or 'AzureStorageDataSource' or 'AzureSubscriptionDataSource' or 'AzureSynapseDataSource' or 'AzureSynapseWorkspaceDataSource' or 'OracleDataSource' or 'PowerBIDataSource' or 'SapEccDataSource' or 'SapS4HanaDataSource' or 'SqlServerDatabaseDataSource' or 'TeradataDataSource'

# JSON input template you can fill out and use as your `json` input.
json = {
    "kind": "DataSource",
    "scans": [
        {
            "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": "DataSource",
    "scans": [
        {
            "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.data_sources.build_get_request(data_source_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

Get a 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 == {
    "kind": "DataSource",
    "scans": [
        {
            "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.data_sources.build_delete_request(data_source_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

Deletes a 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 == {
    "kind": "DataSource",
    "scans": [
        {
            "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.data_sources.build_list_all_request(**kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

List data sources in Data catalog.

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

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": "DataSource",
            "scans": [
                {
                    "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)"
                        }
                    ]
                }
            ]
        }
    ]
}