SmartDetectorAlertRulesOperations Class

SmartDetectorAlertRulesOperations async 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.

Inheritance

builtins.object

SmartDetectorAlertRulesOperations

Constructor

SmartDetectorAlertRulesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Create or update a Smart Detector alert rule.
delete	Delete an existing Smart Detector alert rule.
get	Get a specific Smart Detector alert rule.
list	List all the existing Smart Detector alert rules within the subscription.
list_by_resource_group	List all the existing Smart Detector alert rules within the subscription and resource group.
patch	Patch a specific Smart Detector alert rule.

create_or_update

Create or update a Smart Detector alert rule.

async create_or_update(resource_group_name: str, alert_rule_name: str, parameters: azure.mgmt.alertsmanagement.models._models_py3.AlertRule, **kwargs) -> azure.mgmt.alertsmanagement.models._models_py3.AlertRule

Parameters

resource_group_name

str

Required

The name of the resource group.

alert_rule_name

str

Required

The name of the alert rule.

parameters

AlertRule

Required

Parameters supplied to the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

AlertRule, or the result of cls(response)

Return type

AlertRule

Exceptions

HttpResponseError

delete

Delete an existing Smart Detector alert rule.

async delete(resource_group_name: str, alert_rule_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

alert_rule_name

str

Required

The name of the alert rule.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get a specific Smart Detector alert rule.

async get(resource_group_name: str, alert_rule_name: str, expand_detector: Optional[bool] = None, **kwargs) -> azure.mgmt.alertsmanagement.models._models_py3.AlertRule

Parameters

resource_group_name

str

Required

The name of the resource group.

alert_rule_name

str

Required

The name of the alert rule.

expand_detector

bool

default value: None

Indicates if Smart Detector should be expanded.

cls

callable

A custom type or function that will be passed the direct response

Returns

AlertRule, or the result of cls(response)

Return type

AlertRule

Exceptions

HttpResponseError

list

List all the existing Smart Detector alert rules within the subscription.

list(expand_detector: Optional[bool] = None, **kwargs) -> AsyncIterable[azure.mgmt.alertsmanagement.models._models_py3.AlertRulesList]

Parameters

expand_detector

bool

default value: None

Indicates if Smart Detector should be expanded.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AlertRulesList or the result of cls(response)

Return type

AsyncItemPaged[AlertRulesList]

Exceptions

HttpResponseError

list_by_resource_group

List all the existing Smart Detector alert rules within the subscription and resource group.

list_by_resource_group(resource_group_name: str, expand_detector: Optional[bool] = None, **kwargs) -> AsyncIterable[azure.mgmt.alertsmanagement.models._models_py3.AlertRulesList]

Parameters

resource_group_name

str

Required

The name of the resource group.

expand_detector

bool

default value: None

Indicates if Smart Detector should be expanded.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AlertRulesList or the result of cls(response)

Return type

AsyncItemPaged[AlertRulesList]

Exceptions

HttpResponseError

patch

Patch a specific Smart Detector alert rule.

async patch(resource_group_name: str, alert_rule_name: str, parameters: azure.mgmt.alertsmanagement.models._models_py3.AlertRulePatchObject, **kwargs) -> azure.mgmt.alertsmanagement.models._models_py3.AlertRule

Parameters

resource_group_name

str

Required

The name of the resource group.

alert_rule_name

str

Required

The name of the alert rule.

parameters

AlertRulePatchObject

Required

Parameters supplied to the operation.

cls

callable

A custom type or function that will be passed the direct response

Returns

AlertRule, or the result of cls(response)

Return type

AlertRule

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.alertsmanagement.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\alertsmanagement\\models\\__init__.py'>