ActionRulesOperations Class

ActionRulesOperations 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

ActionRulesOperations

Constructor

ActionRulesOperations(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_update	Create/update an action rule. Creates/Updates a specific action rule.
delete	Delete action rule. Deletes a given action rule.
get_by_name	Get action rule by name. Get a specific action rule.
list_by_resource_group	Get all action rules created in a resource group. List all action rules of the subscription, created in given resource group and given input filters.
list_by_subscription	Get all action rule in a given subscription. List all action rules of the subscription and given input filters.
update	Patch action rule. Update enabled flag and/or tags for the given action rule.

create_update

Create/update an action rule.

Creates/Updates a specific action rule.

async create_update(resource_group_name: str, action_rule_name: str, action_rule: azure.mgmt.alertsmanagement.models._models_py3.ActionRule, **kwargs) -> azure.mgmt.alertsmanagement.models._models_py3.ActionRule

Parameters

resource_group_name

str

Required

Resource group name where the resource is created.

action_rule_name

str

Required

The name of action rule that needs to be created/updated.

action_rule

ActionRule

Required

action rule to be created/updated.

cls

callable

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

Returns

ActionRule, or the result of cls(response)

Return type

ActionRule

Exceptions

HttpResponseError

delete

Delete action rule.

Deletes a given action rule.

async delete(resource_group_name: str, action_rule_name: str, **kwargs) -> bool

Parameters

resource_group_name

str

Required

Resource group name where the resource is created.

action_rule_name

str

Required

The name that needs to be deleted.

cls

callable

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

Returns

bool, or the result of cls(response)

Return type

bool

Exceptions

HttpResponseError

get_by_name

Get action rule by name.

Get a specific action rule.

async get_by_name(resource_group_name: str, action_rule_name: str, **kwargs) -> azure.mgmt.alertsmanagement.models._models_py3.ActionRule

Parameters

resource_group_name

str

Required

Resource group name where the resource is created.

action_rule_name

str

Required

The name of action rule that needs to be fetched.

cls

callable

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

Returns

ActionRule, or the result of cls(response)

Return type

ActionRule

Exceptions

HttpResponseError

list_by_resource_group

Get all action rules created in a resource group.

List all action rules of the subscription, created in given resource group and given input filters.

list_by_resource_group(resource_group_name: str, target_resource_group: Optional[str] = None, target_resource_type: Optional[str] = None, target_resource: Optional[str] = None, severity: Optional[Union[str, azure.mgmt.alertsmanagement.models._alerts_management_client_enums.Severity]] = None, monitor_service: Optional[Union[str, azure.mgmt.alertsmanagement.models._alerts_management_client_enums.MonitorService]] = None, impacted_scope: Optional[str] = None, description: Optional[str] = None, alert_rule_id: Optional[str] = None, action_group: Optional[str] = None, name: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.alertsmanagement.models._models_py3.ActionRulesList]

Parameters

resource_group_name

str

Required

Resource group name where the resource is created.

target_resource_group

str

default value: None

Filter by target resource group name. Default value is select all.

target_resource_type

str

default value: None

Filter by target resource type. Default value is select all.

target_resource

str

default value: None

Filter by target resource( which is full ARM ID) Default value is select all.

severity

str or Severity

default value: None

Filter by severity. Default value is select all.

monitor_service

str or MonitorService

default value: None

Filter by monitor service which generates the alert instance. Default value is select all.

impacted_scope

str

default value: None

filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope.

description

str

default value: None

filter by alert rule description.

alert_rule_id

str

default value: None

filter by alert rule id.

action_group

str

default value: None

filter by action group configured as part of action rule.

name

str

default value: None

filter by action rule name.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[ActionRulesList]

Exceptions

HttpResponseError

list_by_subscription

Get all action rule in a given subscription.

List all action rules of the subscription and given input filters.

list_by_subscription(target_resource_group: Optional[str] = None, target_resource_type: Optional[str] = None, target_resource: Optional[str] = None, severity: Optional[Union[str, azure.mgmt.alertsmanagement.models._alerts_management_client_enums.Severity]] = None, monitor_service: Optional[Union[str, azure.mgmt.alertsmanagement.models._alerts_management_client_enums.MonitorService]] = None, impacted_scope: Optional[str] = None, description: Optional[str] = None, alert_rule_id: Optional[str] = None, action_group: Optional[str] = None, name: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.alertsmanagement.models._models_py3.ActionRulesList]

Parameters

target_resource_group

str

default value: None

Filter by target resource group name. Default value is select all.

target_resource_type

str

default value: None

Filter by target resource type. Default value is select all.

target_resource

str

default value: None

Filter by target resource( which is full ARM ID) Default value is select all.

severity

str or Severity

default value: None

Filter by severity. Default value is select all.

monitor_service

str or MonitorService

default value: None

Filter by monitor service which generates the alert instance. Default value is select all.

impacted_scope

str

default value: None

filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope.

description

str

default value: None

filter by alert rule description.

alert_rule_id

str

default value: None

filter by alert rule id.

action_group

str

default value: None

filter by action group configured as part of action rule.

name

str

default value: None

filter by action rule name.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[ActionRulesList]

Exceptions

HttpResponseError

update

Patch action rule.

Update enabled flag and/or tags for the given action rule.

async update(resource_group_name: str, action_rule_name: str, action_rule_patch: azure.mgmt.alertsmanagement.models._models_py3.PatchObject, **kwargs) -> azure.mgmt.alertsmanagement.models._models_py3.ActionRule

Parameters

resource_group_name

str

Required

Resource group name where the resource is created.

action_rule_name

str

Required

The name that needs to be updated.

action_rule_patch

PatchObject

Required

Parameters supplied to the operation.

cls

callable

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

Returns

ActionRule, or the result of cls(response)

Return type

ActionRule

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'>