ActionGroupsOperations Class

Varning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:action_groups> attribute.

Constructor

Python

ActionGroupsOperations(*args, **kwargs)

Methods

begin_create_notifications_at_resource_group_level	Send test notifications to a set of provided receivers.
begin_post_test_notifications	Send test notifications to a set of provided receivers.
create_or_update	Create a new action group or update an existing one.
delete	Delete an action group.
enable_receiver	Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.
get	Get an action group.
get_test_notifications	Get the test notifications by the notification id.
get_test_notifications_at_resource_group_level	Get the test notifications by the notification id.
list_by_resource_group	Get a list of all action groups in a resource group.
list_by_subscription_id	Get a list of all action groups in a subscription.
update	Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.

begin_create_notifications_at_resource_group_level

Send test notifications to a set of provided receivers.

Python

begin_create_notifications_at_resource_group_level(resource_group_name: str, notification_request: _models.NotificationRequestBody, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TestNotificationDetailsResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
notification_request Required	NotificationRequestBody or IO The notification request body which includes the contact details. Is either a NotificationRequestBody 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
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[TestNotificationDetailsResponse]	An instance of LROPoller that returns either TestNotificationDetailsResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_post_test_notifications

Send test notifications to a set of provided receivers.

Python

begin_post_test_notifications(notification_request: _models.NotificationRequestBody, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TestNotificationDetailsResponse]

Parameters

Name	Description
notification_request Required	NotificationRequestBody or IO The notification request body which includes the contact details. Is either a NotificationRequestBody 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
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[TestNotificationDetailsResponse]	An instance of LROPoller that returns either TestNotificationDetailsResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Create a new action group or update an existing one.

Python

create_or_update(resource_group_name: str, action_group_name: str, action_group: _models.ActionGroupResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ActionGroupResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
action_group_name Required	str The name of the action group. Required.
action_group Required	ActionGroupResource or IO The action group to create or use for the update. Is either a ActionGroupResource 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
ActionGroupResource	ActionGroupResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete an action group.

Python

delete(resource_group_name: str, action_group_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.
action_group_name Required	str The name of the action group. 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

enable_receiver

Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.

Python

enable_receiver(resource_group_name: str, action_group_name: str, enable_request: _models.EnableRequest, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
action_group_name Required	str The name of the action group. Required.
enable_request Required	EnableRequest or IO The receiver to re-enable. Is either a EnableRequest 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
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get an action group.

Python

get(resource_group_name: str, action_group_name: str, **kwargs: Any) -> ActionGroupResource

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get_test_notifications

Get the test notifications by the notification id.

Python

get_test_notifications(notification_id: str, **kwargs: Any) -> TestNotificationDetailsResponse

Parameters

Name	Description
notification_id Required	str The notification id. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get_test_notifications_at_resource_group_level

Get the test notifications by the notification id.

Python

get_test_notifications_at_resource_group_level(resource_group_name: str, notification_id: str, **kwargs: Any) -> TestNotificationDetailsResponse

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get a list of all action groups in a resource group.

Python

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ActionGroupResource]

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[ActionGroupResource]	An iterator like instance of either ActionGroupResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription_id

Get a list of all action groups in a subscription.

Python

list_by_subscription_id(**kwargs: Any) -> Iterable[ActionGroupResource]

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.

Python

update(resource_group_name: str, action_group_name: str, action_group_patch: _models.ActionGroupPatchBody, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ActionGroupResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
action_group_name Required	str The name of the action group. Required.
action_group_patch Required	ActionGroupPatchBody or IO Parameters supplied to the operation. Is either a ActionGroupPatchBody 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
ActionGroupResource	ActionGroupResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

Python

models = <module 'azure.mgmt.monitor.v2022_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv164\\Lib\\site-packages\\azure\\mgmt\\monitor\\v2022_04_01\\models\\__init__.py'>