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

vw_tenant_action_groups

Name	Datatype	Description
id	text	The resource Id.
name	text	The name of the resource.
azure_app_push_receivers	text	field from the properties object
email_receivers	text	field from the properties object
enabled	text	field from the properties object
group_short_name	text	field from the properties object
location	text	The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions.
managementGroupId	text	field from the properties object
sms_receivers	text	field from the properties object
tags	text	The tags of the resource.
tenantActionGroupName	text	field from the properties object
tenantId	text	field from the properties object
type	text	The type of the resource.
voice_receivers	text	field from the properties object
webhook_receivers	text	field from the properties object

tenant_action_groups

Name	Datatype	Description
id	string	The resource Id.
name	string	The name of the resource.
location	string	The location of the resource. Azure Activity Log Alert rules are supported on Global, West Europe and North Europe regions.
properties	object	A tenant action group.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	actionGroupName, managementGroupId, tenantId	Get a tenant action group.
list_by_management_group_id	SELECT	managementGroupId, tenantId	Get a list of all tenant action groups in a management group.
create_or_update	INSERT	actionGroupName, managementGroupId, tenantId	Create a new tenant action group or update an existing one.
delete	DELETE	actionGroupName, managementGroupId, tenantId	Delete a tenant action group.
update	UPDATE	actionGroupName, managementGroupId, tenantId	Updates an existing tenant action group's tags. To update other fields use the CreateOrUpdate method.

SELECT examples

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

vw_tenant_action_groups

SELECT
id,
name,
azure_app_push_receivers,
email_receivers,
enabled,
group_short_name,
location,
managementGroupId,
sms_receivers,
tags,
tenantActionGroupName,
tenantId,
type,
voice_receivers,
webhook_receivers
FROM azure.monitor.vw_tenant_action_groups
WHERE managementGroupId = '{{ managementGroupId }}'
AND tenantId = '{{ tenantId }}';

tenant_action_groups

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.tenant_action_groups
WHERE managementGroupId = '{{ managementGroupId }}'
AND tenantId = '{{ tenantId }}';

INSERT example

Use the following StackQL query and manifest file to create a new tenant_action_groups resource.

All Properties

/*+ create */
INSERT INTO azure.monitor.tenant_action_groups (
actionGroupName,
managementGroupId,
tenantId,
location,
tags,
properties
)
SELECT 
'{{ actionGroupName }}',
'{{ managementGroupId }}',
'{{ tenantId }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: groupShortName
          value: string
        - name: enabled
          value: boolean
        - name: emailReceivers
          value:
            - - name: name
                value: string
              - name: emailAddress
                value: string
              - name: useCommonAlertSchema
                value: boolean
              - name: status
                value: []
        - name: smsReceivers
          value:
            - - name: name
                value: string
              - name: countryCode
                value: string
              - name: phoneNumber
                value: string
        - name: webhookReceivers
          value:
            - - name: name
                value: string
              - name: serviceUri
                value: string
              - name: useCommonAlertSchema
                value: boolean
              - name: useAadAuth
                value: boolean
              - name: objectId
                value: string
              - name: identifierUri
                value: string
              - name: tenantId
                value: string
        - name: azureAppPushReceivers
          value:
            - - name: name
                value: string
              - name: emailAddress
                value: string
        - name: voiceReceivers
          value:
            - - name: name
                value: string
              - name: countryCode
                value: string
              - name: phoneNumber
                value: string

UPDATE example

Updates a tenant_action_groups resource.

/*+ update */
UPDATE azure.monitor.tenant_action_groups
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
actionGroupName = '{{ actionGroupName }}'
AND managementGroupId = '{{ managementGroupId }}'
AND tenantId = '{{ tenantId }}';

DELETE example

Deletes the specified tenant_action_groups resource.

/*+ delete */
DELETE FROM azure.monitor.tenant_action_groups
WHERE actionGroupName = '{{ actionGroupName }}'
AND managementGroupId = '{{ managementGroupId }}'
AND tenantId = '{{ tenantId }}';