Document: "actionGroups_API"
An action group resource.
azure_action_group_resource {
action_group => "actionGroup",
action_group_name => "action_group_name",
api_version => "api_version",
location => "location (optional)",
properties => $azure_action_group
resource_group_name => "resource_group_name",
subscription_id => "subscription_id",
tags => "tags (optional)",
}
Name | Type | Required | Description |
---|---|---|---|
action_group | Hash | true | The action group to create or use for the update. |
action_group_name | String | true | The name of the action group. |
api_version | String | true | Client Api Version. |
location | String | false | Resource location |
properties | ActionGroup | false | The action groups properties of the resource. |
resource_group_name | String | true | The name of the resource group. |
subscription_id | String | true | The Azure subscription Id. |
tags | String | false | Resource tags |
An Azure action group.
$azure_action_group = {
armRoleReceivers => $azure_arm_role_receiver
automationRunbookReceivers => $azure_automation_runbook_receiver
azureAppPushReceivers => $azure_azure_app_push_receiver
azureFunctionReceivers => $azure_azure_function_receiver
emailReceivers => $azure_email_receiver
enabled => "enabled",
groupShortName => "groupShortName",
itsmReceivers => $azure_itsm_receiver
logicAppReceivers => $azure_logic_app_receiver
smsReceivers => $azure_sms_receiver
voiceReceivers => $azure_voice_receiver
webhookReceivers => $azure_webhook_receiver
}
Name | Type | Required | Description |
---|---|---|---|
armRoleReceivers | ArmRoleReceiver | false | The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported. |
automationRunbookReceivers | AutomationRunbookReceiver | false | The list of AutomationRunbook receivers that are part of this action group. |
azureAppPushReceivers | AzureAppPushReceiver | false | The list of AzureAppPush receivers that are part of this action group. |
azureFunctionReceivers | AzureFunctionReceiver | false | The list of azure function receivers that are part of this action group. |
emailReceivers | EmailReceiver | false | The list of email receivers that are part of this action group. |
enabled | Boolean | true | Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. |
groupShortName | String | true | The short name of the action group. This will be used in SMS messages. |
itsmReceivers | ItsmReceiver | false | The list of ITSM receivers that are part of this action group. |
logicAppReceivers | LogicAppReceiver | false | The list of logic app receivers that are part of this action group. |
smsReceivers | SmsReceiver | false | The list of SMS receivers that are part of this action group. |
voiceReceivers | VoiceReceiver | false | The list of voice receivers that are part of this action group. |
webhookReceivers | WebhookReceiver | false | The list of webhook receivers that are part of this action group. |
An arm role receiver.
$azure_arm_role_receiver = {
name => "name",
roleId => "roleId",
useCommonAlertSchema => "useCommonAlertSchema",
}
Name | Type | Required | Description |
---|---|---|---|
name | String | true | The name of the arm role receiver. Names must be unique across all receivers within an action group. |
roleId | String | true | The arm role id. |
useCommonAlertSchema | Boolean | true | Indicates whether to use common alert schema. |
The Azure Automation Runbook notification receiver.
$azure_automation_runbook_receiver = {
automationAccountId => "automationAccountId",
isGlobalRunbook => "isGlobalRunbook",
name => "name (optional)",
runbookName => "runbookName",
serviceUri => "serviceUri (optional)",
useCommonAlertSchema => "useCommonAlertSchema",
webhookResourceId => "webhookResourceId",
}
Name | Type | Required | Description |
---|---|---|---|
automationAccountId | String | true | The Azure automation account Id which holds this runbook and authenticate to Azure resource. |
isGlobalRunbook | Boolean | true | Indicates whether this instance is global runbook. |
name | String | false | Indicates name of the webhook. |
runbookName | String | true | The name for this runbook. |
serviceUri | String | false | The URI where webhooks should be sent. |
useCommonAlertSchema | Boolean | true | Indicates whether to use common alert schema. |
webhookResourceId | String | true | The resource id for webhook linked to this runbook. |
The Azure mobile App push notification receiver.
$azure_azure_app_push_receiver = {
emailAddress => "emailAddress",
name => "name",
}
Name | Type | Required | Description |
---|---|---|---|
emailAddress | String | true | The email address registered for the Azure mobile app. |
name | String | true | The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group. |
An azure function receiver.
$azure_azure_function_receiver = {
functionAppResourceId => "functionAppResourceId",
functionName => "functionName",
httpTriggerUrl => "httpTriggerUrl",
name => "name",
useCommonAlertSchema => "useCommonAlertSchema",
}
Name | Type | Required | Description |
---|---|---|---|
functionAppResourceId | String | true | The azure resource id of the function app. |
functionName | String | true | The function name in the function app. |
httpTriggerUrl | String | true | The http trigger url where http request sent to. |
name | String | true | The name of the azure function receiver. Names must be unique across all receivers within an action group. |
useCommonAlertSchema | Boolean | true | Indicates whether to use common alert schema. |
An email receiver.
$azure_email_receiver = {
emailAddress => "emailAddress",
name => "name",
status => $azure_receiver_status
useCommonAlertSchema => "useCommonAlertSchema",
}
Name | Type | Required | Description |
---|---|---|---|
emailAddress | String | true | The email address of this receiver. |
name | String | true | The name of the email receiver. Names must be unique across all receivers within an action group. |
status | ReceiverStatus | false | The receiver status of the e-mail. |
useCommonAlertSchema | Boolean | true | Indicates whether to use common alert schema. |
Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications.
$azure_receiver_status = {
}
Name | Type | Required | Description |
---|
An Itsm receiver.
$azure_itsm_receiver = {
connectionId => "connectionId",
name => "name",
region => "region",
ticketConfiguration => "ticketConfiguration",
workspaceId => "workspaceId",
}
Name | Type | Required | Description |
---|---|---|---|
connectionId | String | true | Unique identification of ITSM connection among multiple defined in above workspace. |
name | String | true | The name of the Itsm receiver. Names must be unique across all receivers within an action group. |
region | String | true | Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration | String | true | JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well. |
workspaceId | String | true | OMS LA instance identifier. |
A logic app receiver.
$azure_logic_app_receiver = {
callbackUrl => "callbackUrl",
name => "name",
resourceId => "resourceId",
useCommonAlertSchema => "useCommonAlertSchema",
}
Name | Type | Required | Description |
---|---|---|---|
callbackUrl | String | true | The callback url where http request sent to. |
name | String | true | The name of the logic app receiver. Names must be unique across all receivers within an action group. |
resourceId | String | true | The azure resource id of the logic app receiver. |
useCommonAlertSchema | Boolean | true | Indicates whether to use common alert schema. |
An SMS receiver.
$azure_sms_receiver = {
countryCode => "countryCode",
name => "name",
phoneNumber => "phoneNumber",
status => $azure_receiver_status
}
Name | Type | Required | Description |
---|---|---|---|
countryCode | String | true | The country code of the SMS receiver. |
name | String | true | The name of the SMS receiver. Names must be unique across all receivers within an action group. |
phoneNumber | String | true | The phone number of the SMS receiver. |
status | ReceiverStatus | false | The status of the receiver. |
A voice receiver.
$azure_voice_receiver = {
countryCode => "countryCode",
name => "name",
phoneNumber => "phoneNumber",
}
Name | Type | Required | Description |
---|---|---|---|
countryCode | String | true | The country code of the voice receiver. |
name | String | true | The name of the voice receiver. Names must be unique across all receivers within an action group. |
phoneNumber | String | true | The phone number of the voice receiver. |
A webhook receiver.
$azure_webhook_receiver = {
identifierUri => "identifierUri (optional)",
name => "name",
objectId => "objectId (optional)",
serviceUri => "serviceUri",
tenantId => "tenantId (optional)",
useAadAuth => "useAadAuth (optional)",
useCommonAlertSchema => "useCommonAlertSchema",
}
Name | Type | Required | Description |
---|---|---|---|
identifierUri | String | false | Indicates the identifier uri for aad auth. |
name | String | true | The name of the webhook receiver. Names must be unique across all receivers within an action group. |
objectId | String | false | Indicates the webhook app object Id for aad auth. |
serviceUri | String | true | The URI where webhooks should be sent. |
tenantId | String | false | Indicates the tenant id for aad auth. |
useAadAuth | Boolean | false | Indicates whether or not use AAD authentication. |
useCommonAlertSchema | Boolean | true | Indicates whether to use common alert schema. |
Here is a list of endpoints that we use to create, read, update and delete the ActionGroupResource
Operation | Path | Verb | Description | OperationID |
---|---|---|---|---|
Create | /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/microsoft.insights/actionGroups/%{action_group_name} |
Put | Create a new action group or update an existing one. | ActionGroups_CreateOrUpdate |
List - list all | /subscriptions/%{subscription_id}/providers/microsoft.insights/actionGroups |
Get | Get a list of all action groups in a subscription. | ActionGroups_ListBySubscriptionId |
List - get one | /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/microsoft.insights/actionGroups/%{action_group_name} |
Get | Get an action group. | ActionGroups_Get |
List - get list using params | /subscriptions/%{subscription_id}/providers/microsoft.insights/actionGroups |
Get | Get a list of all action groups in a subscription. | ActionGroups_ListBySubscriptionId |
Update | /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/microsoft.insights/actionGroups/%{action_group_name} |
Put | Create a new action group or update an existing one. | ActionGroups_CreateOrUpdate |
Delete | /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/microsoft.insights/actionGroups/%{action_group_name} |
Delete | Delete an action group. | ActionGroups_Delete |