azure.purview.scanning.rest.scan_rulesets package¶

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

Get a scan ruleset.

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

Parameters: scan_ruleset_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": "ScanRuleset"
}

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

Creates or Updates a scan ruleset.

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

Parameters

scan_ruleset_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 = '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 `json` input.
json = {
    "kind": "ScanRuleset"
}


# response body for status code(s): 200, 201
response_body == {
    "kind": "ScanRuleset"
}

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

Deletes a scan ruleset.

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

Parameters: scan_ruleset_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": "ScanRuleset"
}

azure.purview.scanning.rest.scan_rulesets.build_list_all_request(**kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]¶

List scan rulesets 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": "ScanRuleset"
        }
    ]
}