tenant_action_groups

Creates, updates, deletes, gets or lists a tenant_action_groups resource.

Overview

Name	tenant_action_groups
Type	Resource
Id	azure.monitor.tenant_action_groups

Fields

The following fields are returned by SELECT queries:

get

The request succeeded.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The tenant action groups properties of the resource.
tags	object	Resource tags
type	string	Azure resource type

list_by_management_group_id

The request succeeded.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The tenant action groups properties of the resource.
tags	object	Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	managementGroupId, actionGroupName, x-ms-client-tenant-id		Get a tenant action group.
list_by_management_group_id	select	managementGroupId, x-ms-client-tenant-id		Get a list of all tenant action groups in a management group.
create_or_update	insert	managementGroupId, actionGroupName, x-ms-client-tenant-id		Create a new tenant action group or update an existing one.
update	update	managementGroupId, actionGroupName, x-ms-client-tenant-id		Updates an existing tenant action group's tags. To update other fields use the CreateOrUpdate method.
delete	delete	managementGroupId, actionGroupName, x-ms-client-tenant-id		Delete a tenant action group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
actionGroupName	string	The name of the action group.
managementGroupId	string	The management group id.
x-ms-client-tenant-id	string	The tenant ID of the client making the request.

SELECT examples

get

Get a tenant action group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.tenant_action_groups
WHERE managementGroupId = '{{ managementGroupId }}' -- required
AND actionGroupName = '{{ actionGroupName }}' -- required
AND x-ms-client-tenant-id = '{{ x-ms-client-tenant-id }}' -- required
;

list_by_management_group_id

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

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.tenant_action_groups
WHERE managementGroupId = '{{ managementGroupId }}' -- required
AND x-ms-client-tenant-id = '{{ x-ms-client-tenant-id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.monitor.tenant_action_groups (
data__location,
data__tags,
data__properties,
managementGroupId,
actionGroupName,
x-ms-client-tenant-id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ managementGroupId }}',
'{{ actionGroupName }}',
'{{ x-ms-client-tenant-id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: tenant_action_groups
  props:
    - name: managementGroupId
      value: string
      description: Required parameter for the tenant_action_groups resource.
    - name: actionGroupName
      value: string
      description: Required parameter for the tenant_action_groups resource.
    - name: x-ms-client-tenant-id
      value: string
      description: Required parameter for the tenant_action_groups resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        The tenant action groups properties of the resource.

UPDATE examples

update

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

UPDATE azure.monitor.tenant_action_groups
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
managementGroupId = '{{ managementGroupId }}' --required
AND actionGroupName = '{{ actionGroupName }}' --required
AND x-ms-client-tenant-id = '{{ x-ms-client-tenant-id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete a tenant action group.

DELETE FROM azure.monitor.tenant_action_groups
WHERE managementGroupId = '{{ managementGroupId }}' --required
AND actionGroupName = '{{ actionGroupName }}' --required
AND x-ms-client-tenant-id = '{{ x-ms-client-tenant-id }}' --required
;