TenantActionGroupsOperations Class

Varning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:tenant_action_groups> attribute.

Constructor

Python

TenantActionGroupsOperations(*args, **kwargs)

Methods

create_or_update	Create a new tenant action group or update an existing one.
delete	Delete a tenant action group.
get	Get a tenant action group.
list_by_management_group_id	Get a list of all tenant action groups in a management group.
update	Updates an existing tenant action group's tags. To update other fields use the CreateOrUpdate method.

create_or_update

Create a new tenant action group or update an existing one.

Python

create_or_update(management_group_id: str, tenant_action_group_name: str, x_ms_client_tenant_id: str, action_group: _models.TenantActionGroupResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TenantActionGroupResource

Parameters

Name	Description
management_group_id Required	str The management group id. Required.
tenant_action_group_name Required	str The name of the action group. Required.
x_ms_client_tenant_id Required	str The tenant ID of the client making the request. Required.
action_group Required	TenantActionGroupResource or IO The tenant action group to create or use for the update. Is either a TenantActionGroupResource 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
TenantActionGroupResource	TenantActionGroupResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete a tenant action group.

Python

delete(management_group_id: str, tenant_action_group_name: str, x_ms_client_tenant_id: str, **kwargs: Any) -> None

Parameters

Name	Description
management_group_id Required	str The management group id. Required.
tenant_action_group_name Required	str The name of the action group. Required.
x_ms_client_tenant_id Required	str The tenant ID of the client making the request. 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

Get a tenant action group.

Python

get(management_group_id: str, tenant_action_group_name: str, x_ms_client_tenant_id: str, **kwargs: Any) -> TenantActionGroupResource

Parameters

Name	Description
management_group_id Required	str The management group id. Required.
tenant_action_group_name Required	str The name of the action group. Required.
x_ms_client_tenant_id Required	str The tenant ID of the client making the request. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_management_group_id

Get a list of all tenant action groups in a management group.

Python

list_by_management_group_id(management_group_id: str, x_ms_client_tenant_id: str, **kwargs: Any) -> Iterable[TenantActionGroupResource]

Parameters

Name	Description
management_group_id Required	str The management group id. Required.
x_ms_client_tenant_id Required	str The tenant ID of the client making the request. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

update

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

Python

update(management_group_id: str, tenant_action_group_name: str, x_ms_client_tenant_id: str, tenant_action_group_patch: _models.ActionGroupPatchBody, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TenantActionGroupResource

Parameters

Name	Description
management_group_id Required	str The management group id. Required.
tenant_action_group_name Required	str The name of the action group. Required.
x_ms_client_tenant_id Required	str The tenant ID of the client making the request. Required.
tenant_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
TenantActionGroupResource	TenantActionGroupResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

Python

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