MetricAlertsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:metric_alerts> attribute.

Constructor

MetricAlertsOperations(*args, **kwargs)

Methods

create_or_update	Create or update an metric alert definition.
delete	Delete an alert rule definition.
get	Retrieve an alert rule definition.
list_by_resource_group	Retrieve alert rule definitions in a resource group.
list_by_subscription	Retrieve alert rule definitions in a subscription.
update	Update an metric alert definition.

create_or_update

Create or update an metric alert definition.

create_or_update(resource_group_name: str, rule_name: str, parameters: _models.MetricAlertResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.MetricAlertResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
rule_name Required	str The name of the rule. Required.
parameters Required	MetricAlertResource or IO[bytes] The parameters of the rule to create or update. Is either a MetricAlertResource type or a IO[bytes] type. Required.

Returns

Type	Description
MetricAlertResource	MetricAlertResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete an alert rule definition.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
rule_name Required	str The name of the rule. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Retrieve an alert rule definition.

get(resource_group_name: str, rule_name: str, **kwargs: Any) -> MetricAlertResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
rule_name Required	str The name of the rule. Required.

Returns

Type	Description
MetricAlertResource	MetricAlertResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Retrieve alert rule definitions in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[MetricAlertResource]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Retrieve alert rule definitions in a subscription.

list_by_subscription(**kwargs: Any) -> ItemPaged[MetricAlertResource]

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Update an metric alert definition.

update(resource_group_name: str, rule_name: str, parameters: _models.MetricAlertResourcePatch, *, content_type: str = 'application/json', **kwargs: Any) -> _models.MetricAlertResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
rule_name Required	str The name of the rule. Required.
parameters Required	MetricAlertResourcePatch or IO[bytes] The parameters of the rule to update. Is either a MetricAlertResourcePatch type or a IO[bytes] type. Required.

Returns

Type	Description
MetricAlertResource	MetricAlertResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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