azure.purview.scanning.operations package

class azure.purview.scanning.operations.ClassificationRulesOperations(client, config, serializer, deserializer)

ClassificationRulesOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(classification_rule_name: str, body: Any = None, **kwargs: Any) → Any

Creates or Updates a classification rule.

Parameters

• classification_rule_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

kind = 'CustomClassificationRule' or 'SystemClassificationRule'

# JSON input template you can fill out and use as your body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    kind: ClassificationRule
}

# response body for status code(s): 200, 201
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    kind: ClassificationRule
}

delete(classification_rule_name: str, **kwargs: Any) → Optional[Any]

Deletes a classification rule.

Parameters

classification_rule_name (str) –

Returns

JSON object

Return type

Any or None

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    kind: ClassificationRule
}

get(classification_rule_name: str, **kwargs: Any) → Any

Get a classification rule.

Parameters

classification_rule_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    kind: ClassificationRule
}

list_all(**kwargs: Any) → Iterable[Any]

List classification rules in Account.

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            kind: ClassificationRule
        }
    ]
}

list_versions_by_classification_rule_name(classification_rule_name: str, **kwargs: Any) → Iterable[Any]

Lists the rule versions of a classification rule.

Parameters

classification_rule_name (str) –

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            kind: ClassificationRule
        }
    ]
}

tag_classification_version(classification_rule_name: str, classification_rule_version: int, **kwargs: Any) → Any

Sets Classification Action on a specific classification rule version.

Parameters

• classification_rule_name (str) –

• classification_rule_version (int) –

Keyword Arguments

action (str) – Possible values are: “Keep” or “Delete”.

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# 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".
}

class azure.purview.scanning.operations.DataSourcesOperations(client, config, serializer, deserializer)

DataSourcesOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(data_source_name: str, body: Any = None, **kwargs: Any) → Any

Creates or Updates a data source.

Parameters

• data_source_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

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 body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scans": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanResults": [
                {
                    "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.
                }
            ],
            kind: Scan
        }
    ],
    kind: DataSource
}

# response body for status code(s): 200, 201
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scans": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanResults": [
                {
                    "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.
                }
            ],
            kind: Scan
        }
    ],
    kind: DataSource
}

delete(data_source_name: str, **kwargs: Any) → Optional[Any]

Deletes a data source.

Parameters

data_source_name (str) –

Returns

JSON object

Return type

Any or None

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scans": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanResults": [
                {
                    "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.
                }
            ],
            kind: Scan
        }
    ],
    kind: DataSource
}

get(data_source_name: str, **kwargs: Any) → Any

Get a data source.

Parameters

data_source_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scans": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanResults": [
                {
                    "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.
                }
            ],
            kind: Scan
        }
    ],
    kind: DataSource
}

list_all(**kwargs: Any) → Iterable[Any]

List data sources in Data catalog.

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scans": [
                {
                    "id": "str",  # Optional.
                    "name": "str",  # Optional.
                    "scanResults": [
                        {
                            "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.
                        }
                    ],
                    kind: Scan
                }
            ],
            kind: DataSource
        }
    ]
}

class azure.purview.scanning.operations.FiltersOperations(client, config, serializer, deserializer)

FiltersOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(data_source_name: str, scan_name: str, body: Any = None, **kwargs: Any) → Any

Creates or updates a filter.

Parameters

• data_source_name (str) –

• scan_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# JSON input template you can fill out and use as your body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "excludeUriPrefixes": [
            "str"  # Optional.
        ],
        "includeUriPrefixes": [
            "str"  # Optional.
        ]
    }
}

# response body for status code(s): 200, 201
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "excludeUriPrefixes": [
            "str"  # Optional.
        ],
        "includeUriPrefixes": [
            "str"  # Optional.
        ]
    }
}

get(data_source_name: str, scan_name: str, **kwargs: Any) → Any

Get a filter.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "excludeUriPrefixes": [
            "str"  # Optional.
        ],
        "includeUriPrefixes": [
            "str"  # Optional.
        ]
    }
}

class azure.purview.scanning.operations.KeyVaultConnectionsOperations(client, config, serializer, deserializer)

KeyVaultConnectionsOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create(key_vault_name: str, body: Any, **kwargs: Any) → Any

Creates an instance of a key vault connection.

Parameters

• key_vault_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# JSON input template you can fill out and use as your body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "baseUrl": "str",  # Optional.
        "description": "str"  # Optional.
    }
}

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "baseUrl": "str",  # Optional.
        "description": "str"  # Optional.
    }
}

delete(key_vault_name: str, **kwargs: Any) → Optional[Any]

Deletes the key vault connection associated with the account.

Parameters

key_vault_name (str) –

Returns

JSON object

Return type

Any or None

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "baseUrl": "str",  # Optional.
        "description": "str"  # Optional.
    }
}

get(key_vault_name: str, **kwargs: Any) → Any

Gets key vault information.

Parameters

key_vault_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "baseUrl": "str",  # Optional.
        "description": "str"  # Optional.
    }
}

list_all(**kwargs: Any) → Iterable[Any]

List key vault connections in account.

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "properties": {
                "baseUrl": "str",  # Optional.
                "description": "str"  # Optional.
            }
        }
    ]
}

class azure.purview.scanning.operations.ScanResultOperations(client, config, serializer, deserializer)

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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Cancels a scan.

Parameters

• data_source_name (str) –

• scan_name (str) –

• run_id (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# 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(data_source_name: str, scan_name: str, **kwargs: Any) → Iterable[Any]

Lists the scan history of a scan.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# 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(data_source_name: str, scan_name: str, run_id: str, **kwargs: Any) → Any

Runs the scan.

Parameters

• data_source_name (str) –

• scan_name (str) –

• run_id (str) –

Keyword Arguments

scan_level (str) – Possible values are: “Full” or “Incremental”.

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# 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".
}

class azure.purview.scanning.operations.ScanRulesetsOperations(client, config, serializer, deserializer)

ScanRulesetsOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(scan_ruleset_name: str, body: Any = None, **kwargs: Any) → Any

Creates or Updates a scan ruleset.

Parameters

• scan_ruleset_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

kind = 'AdlsGen1ScanRuleset' or 'AdlsGen2ScanRuleset' or 'AmazonAccountScanRuleset' or 'AmazonPostgreSqlScanRuleset' or 'AmazonS3ScanRuleset' or 'AmazonSqlScanRuleset' or 'AzureCosmosDbScanRuleset' or 'AzureDataExplorerScanRuleset' or 'AzureFileServiceScanRuleset' or 'AzureMySqlScanRuleset' or 'AzurePostgreSqlScanRuleset' or 'AzureResourceGroupScanRuleset' or 'AzureSqlDataWarehouseScanRuleset' or 'AzureSqlDatabaseScanRuleset' or 'AzureSqlDatabaseManagedInstanceScanRuleset' or 'AzureStorageScanRuleset' or 'AzureSubscriptionScanRuleset' or 'AzureSynapseScanRuleset' or 'AzureSynapseWorkspaceScanRuleset' or 'OracleScanRuleset' or 'PowerBIScanRuleset' or 'SapEccScanRuleset' or 'SapS4HanaScanRuleset' or 'SqlServerDatabaseScanRuleset' or 'TeradataScanRuleset'

# JSON input template you can fill out and use as your body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: ScanRuleset
}

# response body for status code(s): 200, 201
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: ScanRuleset
}

delete(scan_ruleset_name: str, **kwargs: Any) → Optional[Any]

Deletes a scan ruleset.

Parameters

scan_ruleset_name (str) –

Returns

JSON object

Return type

Any or None

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: ScanRuleset
}

get(scan_ruleset_name: str, **kwargs: Any) → Any

Get a scan ruleset.

Parameters

scan_ruleset_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: ScanRuleset
}

list_all(**kwargs: Any) → Iterable[Any]

List scan rulesets in Data catalog.

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
            "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
            "version": 0,  # Optional.
            kind: ScanRuleset
        }
    ]
}

class azure.purview.scanning.operations.ScansOperations(client, config, serializer, deserializer)

ScansOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(data_source_name: str, scan_name: str, body: Any, **kwargs: Any) → Any

Creates an instance of a scan.

Parameters

• data_source_name (str) –

• scan_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

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 body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanResults": [
        {
            "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.
        }
    ],
    kind: Scan
}

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

delete(data_source_name: str, scan_name: str, **kwargs: Any) → Optional[Any]

Deletes the scan associated with the data source.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

JSON object

Return type

Any or None

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanResults": [
        {
            "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.
        }
    ],
    kind: Scan
}

get(data_source_name: str, scan_name: str, **kwargs: Any) → Any

Gets a scan information.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanResults": [
        {
            "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.
        }
    ],
    kind: Scan
}

list_by_data_source(data_source_name: str, **kwargs: Any) → Iterable[Any]

List scans in data source.

Parameters

data_source_name (str) –

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanResults": [
                {
                    "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.
                }
            ],
            kind: Scan
        }
    ]
}

class azure.purview.scanning.operations.SystemScanRulesetsOperations(client, config, serializer, deserializer)

SystemScanRulesetsOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(data_source_type: str, **kwargs: Any) → Any

Get a system scan ruleset for a data source.

Parameters

data_source_type (str) – Possible values are: “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”, and “PowerBI”.

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: SystemScanRuleset
}

get_by_version(version: int, **kwargs: Any) → Any

Get a scan ruleset by version.

Parameters

version (int) –

Keyword Arguments

data_source_type (str) – Possible values are: “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”, and “PowerBI”.

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: SystemScanRuleset
}

get_latest(**kwargs: Any) → Any

Get the latest version of a system scan ruleset.

Keyword Arguments

data_source_type (str) – Possible values are: “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”, and “PowerBI”.

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
    "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
    "version": 0,  # Optional.
    kind: SystemScanRuleset
}

list_all(**kwargs: Any) → Iterable[Any]

List all system scan rulesets for an account.

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
            "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
            "version": 0,  # Optional.
            kind: SystemScanRuleset
        }
    ]
}

list_versions_by_data_source(**kwargs: Any) → Iterable[Any]

List system scan ruleset versions in Data catalog.

Keyword Arguments

data_source_type (str) – Possible values are: “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”, and “PowerBI”.

Returns

An iterator like instance of JSON object

Return type

ItemPaged[Any]

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "count": 0.0,  # Optional.
    "nextLink": "str",  # Optional.
    "value": [
        {
            "id": "str",  # Optional.
            "name": "str",  # Optional.
            "scanRulesetType": "str",  # Optional. Possible values include: "Custom", "System".
            "status": "str",  # Optional. Possible values include: "Enabled", "Disabled".
            "version": 0,  # Optional.
            kind: SystemScanRuleset
        }
    ]
}

class azure.purview.scanning.operations.TriggersOperations(client, config, serializer, deserializer)

TriggersOperations 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.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_trigger(data_source_name: str, scan_name: str, body: Any, **kwargs: Any) → Any

Creates an instance of a trigger.

Parameters

• data_source_name (str) –

• scan_name (str) –

• body (Any) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# JSON input template you can fill out and use as your body input.
body = {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "createdAt": "2020-02-20 00:00:00",  # Optional.
        "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
        "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
        "lastScheduled": "2020-02-20 00:00:00",  # Optional.
        "recurrence": {
            "endTime": "2020-02-20 00:00:00",  # Optional.
            "frequency": "str",  # Optional. Possible values include: "Week", "Month".
            "interval": 0,  # Optional.
            "schedule": {
                "hours": [
                    0  # Optional.
                ],
                "minutes": [
                    0  # Optional.
                ],
                "monthDays": [
                    0  # Optional.
                ],
                "monthlyOccurrences": [
                    {
                        "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                        "occurrence": 0  # Optional.
                    }
                ],
                "weekDays": [
                    "str"  # Optional.
                ]
            },
            "startTime": "2020-02-20 00:00:00",  # Optional.
            "timeZone": "str"  # Optional.
        },
        "recurrenceInterval": "str",  # Optional.
        "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
    }
}

# response body for status code(s): 200, 201
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "createdAt": "2020-02-20 00:00:00",  # Optional.
        "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
        "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
        "lastScheduled": "2020-02-20 00:00:00",  # Optional.
        "recurrence": {
            "endTime": "2020-02-20 00:00:00",  # Optional.
            "frequency": "str",  # Optional. Possible values include: "Week", "Month".
            "interval": 0,  # Optional.
            "schedule": {
                "hours": [
                    0  # Optional.
                ],
                "minutes": [
                    0  # Optional.
                ],
                "monthDays": [
                    0  # Optional.
                ],
                "monthlyOccurrences": [
                    {
                        "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                        "occurrence": 0  # Optional.
                    }
                ],
                "weekDays": [
                    "str"  # Optional.
                ]
            },
            "startTime": "2020-02-20 00:00:00",  # Optional.
            "timeZone": "str"  # Optional.
        },
        "recurrenceInterval": "str",  # Optional.
        "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
    }
}

delete_trigger(data_source_name: str, scan_name: str, **kwargs: Any) → Optional[Any]

Deletes the trigger associated with the scan.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

JSON object

Return type

Any or None

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "createdAt": "2020-02-20 00:00:00",  # Optional.
        "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
        "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
        "lastScheduled": "2020-02-20 00:00:00",  # Optional.
        "recurrence": {
            "endTime": "2020-02-20 00:00:00",  # Optional.
            "frequency": "str",  # Optional. Possible values include: "Week", "Month".
            "interval": 0,  # Optional.
            "schedule": {
                "hours": [
                    0  # Optional.
                ],
                "minutes": [
                    0  # Optional.
                ],
                "monthDays": [
                    0  # Optional.
                ],
                "monthlyOccurrences": [
                    {
                        "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                        "occurrence": 0  # Optional.
                    }
                ],
                "weekDays": [
                    "str"  # Optional.
                ]
            },
            "startTime": "2020-02-20 00:00:00",  # Optional.
            "timeZone": "str"  # Optional.
        },
        "recurrenceInterval": "str",  # Optional.
        "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
    }
}

get_trigger(data_source_name: str, scan_name: str, **kwargs: Any) → Any

Gets trigger information.

Parameters

• data_source_name (str) –

• scan_name (str) –

Returns

JSON object

Return type

Any

Raises

~azure.core.exceptions.HttpResponseError

Example

# response body for status code(s): 200
response.json() == {
    "id": "str",  # Optional.
    "name": "str",  # Optional.
    "properties": {
        "createdAt": "2020-02-20 00:00:00",  # Optional.
        "incrementalScanStartTime": "2020-02-20 00:00:00",  # Optional.
        "lastModifiedAt": "2020-02-20 00:00:00",  # Optional.
        "lastScheduled": "2020-02-20 00:00:00",  # Optional.
        "recurrence": {
            "endTime": "2020-02-20 00:00:00",  # Optional.
            "frequency": "str",  # Optional. Possible values include: "Week", "Month".
            "interval": 0,  # Optional.
            "schedule": {
                "hours": [
                    0  # Optional.
                ],
                "minutes": [
                    0  # Optional.
                ],
                "monthDays": [
                    0  # Optional.
                ],
                "monthlyOccurrences": [
                    {
                        "day": "str",  # Optional. Possible values include: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday".
                        "occurrence": 0  # Optional.
                    }
                ],
                "weekDays": [
                    "str"  # Optional.
                ]
            },
            "startTime": "2020-02-20 00:00:00",  # Optional.
            "timeZone": "str"  # Optional.
        },
        "recurrenceInterval": "str",  # Optional.
        "scanLevel": "str"  # Optional. Possible values include: "Full", "Incremental".
    }
}