☰
Navigation :

azActionGroup

Use the resource azActionGroup to deploy an Azure Action Group to the relevant subscription.

Attributes

Attribute Type Mandatory Values Default Notes
Name String Yes
ResourceGroupName String Yes
Region String Yes
DisplayName String Yes Defaults to RG of resource
Notification Object No
Action Object No
Lock Object No

Notification

Attribute Type Mandatory Values Default Notes
Name String Yes
RoleName String No Contributor
Owner
Reader
MonitoringContributor
MonitoringReader
EmailAddress String No
SMSCountryCode String No
SMSPhoneNumber String No
VoiceCountryCode String No
VoicePhoneNumber String No
AppPushEmailAddress String No

Action

Attribute Type Mandatory Values Default Notes
Name String Yes
WebhookUri String No
SecureWebhook Object No
EventHub Object No
AutomationRunbook String No
Function String No
ITSM String No
LogicApp String No

SecureWebhook

Attribute Type Mandatory Values Default Notes
Uri String Yes
Identity String Yes

EventHub

Attribute Type Mandatory Values Default Notes
Name String Yes
Namespace String Yes
ResourceGroupName String No
Subscription String No

Input by YAML

Object model for YAML deployment:

---
azActionGroup:
    # Mandatory
  - Name: 'string'
    ConnectionName: 'string'
    ResourceGroupName: 'string'
    Region: 'string'
    DisplayName: 'string'
    # Optional
    Notification:
      - Name: 'string'
        RoleName: 'string'                                  # Contributor, Owner, Reader, MonitoringContributor, MonitoringReader
        EmailAddress: 'string'
        SMSCountryCode: 'string'
        SMSPhoneNumber: 'string'
        VoiceCountryCode: 'string'
        VoicePhoneNumber: 'string'
        AppPushEmailAddress: 'string' 
    Action:
      - Name: 'string'
        WebhookUri: 'string'
        SecureWebhook:
          Uri: 'string'                                     # Will authenticate with AAD
          Identity: 'string'                                # Identity to authenticate with AAD
        EventHub:
          Name: 'string' 
          Namespace: 'string'
          ResourceGroupName: 'string'                       # Defaults to RG of resource
          Subscription: 'string'                            # Defaults to subscription of resource
        AutomationRunbook: 'string'
        Function: 'string'
        ITSM: 'string'
        LogicApp: 'string'
    Lock:
      - Name: 'string'
        Level: 'string'                                     # CanNotDelete, ReadOnly
        Notes: 'string'

Input by JSON

Object model for JSON deployment:

{
  "azActionGroup": [
    {
      "Name": "string",
      "ConnectionName": "string",
      "ResourceGroupName": "string",
      "Region": "string",
      "DisplayName": "string",
      "Notification": [
        {
          "Name": "string",
          "RoleName": "string",
          "EmailAddress": "string",
          "SMSCountryCode": "string",
          "SMSPhoneNumber": "string",
          "VoiceCountryCode": "string",
          "VoicePhoneNumber": "string",
          "AppPushEmailAddress": "string"
        }
      ],
      "Action": [
        {
          "Name": "string",
          "WebhookUri": "string",
          "SecureWebhook": {
            "Uri": "string",
            "Identity": "string"
          },
          "EventHub": {
            "Name": "string",
            "Namespace": "string",
            "ResourceGroupName": "string",
            "Subscription": "string"
          },
          "AutomationRunbook": "string",
          "Function": "string",
          "ITSM": "string",
          "LogicApp": "string"
        }
      ],
      "Lock": [
        {
          "Name": "string",
          "Level": "string",
          "Notes": "string"
        }
      ]
    }
  ]
}