ActionGroupsOperations Class

ActionGroupsOperations 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

ActionGroupsOperations

Constructor

ActionGroupsOperations(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 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.
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.

create_or_update

Create a new action group or update an existing one.

async create_or_update(resource_group_name: str, action_group_name: str, action_group: azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupResource, **kwargs: Any) -> azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupResource

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

action_group_name

str

Required

The name of the action group.

action_group

<xref:$>(<xref:python-base-namespace>)ActionGroupResource

Required

The action group to create or use for the update.

cls

callable

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

Returns

ActionGroupResource, or the result of cls(response)

Return type

<xref:$>(<xref:python-base-namespace>)ActionGroupResource

Exceptions

HttpResponseError

delete

Delete an action group.

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

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

action_group_name

str

Required

The name of the action group.

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

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.

async enable_receiver(resource_group_name: str, action_group_name: str, enable_request: azure.mgmt.monitor.v2018_09_01.models._models_py3.EnableRequest, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

action_group_name

str

Required

The name of the action group.

enable_request

<xref:$>(<xref:python-base-namespace>)EnableRequest

Required

The receiver to re-enable.

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 an action group.

async get(resource_group_name: str, action_group_name: str, **kwargs: Any) -> azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupResource

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

action_group_name

str

Required

The name of the action group.

cls

callable

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

Returns

ActionGroupResource, or the result of cls(response)

Return type

<xref:$>(<xref:python-base-namespace>)ActionGroupResource

Exceptions

HttpResponseError

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:$>(<xref:python-base-namespace>)ActionGroupList]

Exceptions

HttpResponseError

list_by_subscription_id

Get a list of all action groups in a subscription.

list_by_subscription_id(**kwargs: Any) -> AsyncIterable[azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupList]

Parameters

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:$>(<xref:python-base-namespace>)ActionGroupList]

Exceptions

HttpResponseError

update

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

async update(resource_group_name: str, action_group_name: str, action_group_patch: azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupPatchBody, **kwargs: Any) -> azure.mgmt.monitor.v2018_09_01.models._models_py3.ActionGroupResource

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

action_group_name

str

Required

The name of the action group.

action_group_patch

<xref:$>(<xref:python-base-namespace>)ActionGroupPatchBody

Required

Parameters supplied to the operation.

cls

callable

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

Returns

ActionGroupResource, or the result of cls(response)

Return type

<xref:$>(<xref:python-base-namespace>)ActionGroupResource

Exceptions

HttpResponseError

Attributes

models

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