azure.purview.scanning.rest.classification_rules package

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

Get a classification rule.

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

Parameters

classification_rule_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": "ClassificationRule"
}
azure.purview.scanning.rest.classification_rules.build_create_or_update_request(classification_rule_name: str, *, json: Any = None, content: Any = None, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]

Creates or Updates a classification rule.

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

Parameters

classification_rule_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 = 'CustomClassificationRule' or 'SystemClassificationRule'

# JSON input template you can fill out and use as your `json` input.
json = {
    "kind": "ClassificationRule"
}


# response body for status code(s): 200, 201
response_body == {
    "kind": "ClassificationRule"
}
azure.purview.scanning.rest.classification_rules.build_delete_request(classification_rule_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]

Deletes a classification rule.

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

Parameters

classification_rule_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": "ClassificationRule"
}
azure.purview.scanning.rest.classification_rules.build_list_all_request(**kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]

List classification rules in Account.

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": "ClassificationRule"
        }
    ]
}
azure.purview.scanning.rest.classification_rules.build_list_versions_by_classification_rule_name_request(classification_rule_name: str, **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]

Lists the rule versions of a classification rule.

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

Parameters

classification_rule_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": "ClassificationRule"
        }
    ]
}
azure.purview.scanning.rest.classification_rules.build_tag_classification_version_request(classification_rule_name: str, classification_rule_version: int, *, action: Union[str, _models.ClassificationAction], **kwargs: Any) → azure.purview.scanning.core.rest._rest_py3.HttpRequest[source]

Sets Classification Action on a specific classification rule version.

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

Parameters
  • classification_rule_name (str) –

  • classification_rule_version (int) –

Keyword Arguments

action (str or ClassificationAction) –

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)"
}