AlertRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SecurityInsights's

<xref:alert_rules> attribute.

Constructor

AlertRulesOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates the alert rule.
delete	Delete the alert rule.
get	Gets the alert rule.
list	Gets all alert rules.

create_or_update

Creates or updates the alert rule.

create_or_update(resource_group_name: str, workspace_name: str, rule_id: str, alert_rule: AlertRule, **kwargs: Any) -> AlertRule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
rule_id Required	str Alert rule ID.
alert_rule Required	AlertRule The alert rule.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AlertRule	AlertRule, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete the alert rule.

delete(resource_group_name: str, workspace_name: str, rule_id: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
rule_id Required	str Alert rule ID.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the alert rule.

get(resource_group_name: str, workspace_name: str, rule_id: str, **kwargs: Any) -> AlertRule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
rule_id Required	str Alert rule ID.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AlertRule	AlertRule, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all alert rules.

list(resource_group_name: str, workspace_name: str, **kwargs: Any) -> Iterable[AlertRulesList]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[AlertRulesList]	An iterator like instance of either AlertRulesList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.securityinsight.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv214\\Lib\\site-packages\\azure\\mgmt\\securityinsight\\models\\__init__.py'>