MetricAlertsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:metric_alerts> attribute.

Inheritance

builtins.object

MetricAlertsOperations

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 The parameters of the rule to create or update. Is either a MetricAlertResource type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

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.

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

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.

Keyword-Only Parameters

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

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) -> Iterable[MetricAlertResource]

Parameters

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

Keyword-Only Parameters

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

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) -> Iterable[MetricAlertResource]

Keyword-Only Parameters

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

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 The parameters of the rule to update. Is either a MetricAlertResourcePatch type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.monitor.v2018_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\monitor\\v2018_03_01\\models\\__init__.py'>