Docs Home
We recommend using Azure Native.
Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
azure.monitoring.ActionGroup
Explore with Pulumi AI
Manages an Action Group within Azure Monitor.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "monitoring-resources",
location: "West Europe",
});
const current = azure.core.getClientConfig({});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
name: "workspace-01",
location: example.location,
resourceGroupName: example.name,
});
const exampleActionGroup = new azure.monitoring.ActionGroup("example", {
name: "CriticalAlertsAction",
resourceGroupName: example.name,
shortName: "p0action",
armRoleReceivers: [{
name: "armroleaction",
roleId: "de139f84-1756-47ae-9be6-808fbbe84772",
useCommonAlertSchema: true,
}],
automationRunbookReceivers: [{
name: "action_name_1",
automationAccountId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001",
runbookName: "my runbook",
webhookResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001/webHooks/webhook_alert",
isGlobalRunbook: true,
serviceUri: "https://s13events.azure-automation.net/webhooks?token=randomtoken",
useCommonAlertSchema: true,
}],
azureAppPushReceivers: [{
name: "pushtoadmin",
emailAddress: "admin@contoso.com",
}],
azureFunctionReceivers: [{
name: "funcaction",
functionAppResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp",
functionName: "myfunc",
httpTriggerUrl: "https://example.com/trigger",
useCommonAlertSchema: true,
}],
emailReceivers: [
{
name: "sendtoadmin",
emailAddress: "admin@contoso.com",
},
{
name: "sendtodevops",
emailAddress: "devops@contoso.com",
useCommonAlertSchema: true,
},
],
eventHubReceivers: [{
name: "sendtoeventhub",
eventHubNamespace: "eventhubnamespace",
eventHubName: "eventhub1",
subscriptionId: "00000000-0000-0000-0000-000000000000",
useCommonAlertSchema: false,
}],
itsmReceivers: [{
name: "createorupdateticket",
workspaceId: pulumi.all([current, exampleAnalyticsWorkspace.workspaceId]).apply(([current, workspaceId]) => `${current.subscriptionId}|${workspaceId}`),
connectionId: "53de6956-42b4-41ba-be3c-b154cdf17b13",
ticketConfiguration: "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}",
region: "southcentralus",
}],
logicAppReceivers: [{
name: "logicappaction",
resourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp",
callbackUrl: "https://logicapptriggerurl/...",
useCommonAlertSchema: true,
}],
smsReceivers: [{
name: "oncallmsg",
countryCode: "1",
phoneNumber: "1231231234",
}],
voiceReceivers: [{
name: "remotesupport",
countryCode: "86",
phoneNumber: "13888888888",
}],
webhookReceivers: [{
name: "callmyapiaswell",
serviceUri: "http://example.com/alert",
useCommonAlertSchema: true,
}],
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="monitoring-resources",
location="West Europe")
current = azure.core.get_client_config()
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
name="workspace-01",
location=example.location,
resource_group_name=example.name)
example_action_group = azure.monitoring.ActionGroup("example",
name="CriticalAlertsAction",
resource_group_name=example.name,
short_name="p0action",
arm_role_receivers=[{
"name": "armroleaction",
"role_id": "de139f84-1756-47ae-9be6-808fbbe84772",
"use_common_alert_schema": True,
}],
automation_runbook_receivers=[{
"name": "action_name_1",
"automation_account_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001",
"runbook_name": "my runbook",
"webhook_resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001/webHooks/webhook_alert",
"is_global_runbook": True,
"service_uri": "https://s13events.azure-automation.net/webhooks?token=randomtoken",
"use_common_alert_schema": True,
}],
azure_app_push_receivers=[{
"name": "pushtoadmin",
"email_address": "admin@contoso.com",
}],
azure_function_receivers=[{
"name": "funcaction",
"function_app_resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp",
"function_name": "myfunc",
"http_trigger_url": "https://example.com/trigger",
"use_common_alert_schema": True,
}],
email_receivers=[
{
"name": "sendtoadmin",
"email_address": "admin@contoso.com",
},
{
"name": "sendtodevops",
"email_address": "devops@contoso.com",
"use_common_alert_schema": True,
},
],
event_hub_receivers=[{
"name": "sendtoeventhub",
"event_hub_namespace": "eventhubnamespace",
"event_hub_name": "eventhub1",
"subscription_id": "00000000-0000-0000-0000-000000000000",
"use_common_alert_schema": False,
}],
itsm_receivers=[{
"name": "createorupdateticket",
"workspace_id": example_analytics_workspace.workspace_id.apply(lambda workspace_id: f"{current.subscription_id}|{workspace_id}"),
"connection_id": "53de6956-42b4-41ba-be3c-b154cdf17b13",
"ticket_configuration": "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}",
"region": "southcentralus",
}],
logic_app_receivers=[{
"name": "logicappaction",
"resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp",
"callback_url": "https://logicapptriggerurl/...",
"use_common_alert_schema": True,
}],
sms_receivers=[{
"name": "oncallmsg",
"country_code": "1",
"phone_number": "1231231234",
}],
voice_receivers=[{
"name": "remotesupport",
"country_code": "86",
"phone_number": "13888888888",
}],
webhook_receivers=[{
"name": "callmyapiaswell",
"service_uri": "http://example.com/alert",
"use_common_alert_schema": True,
}])
package main
import (
"fmt"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/monitoring"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("monitoring-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
if err != nil {
return err
}
exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
Name: pulumi.String("workspace-01"),
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
_, err = monitoring.NewActionGroup(ctx, "example", &monitoring.ActionGroupArgs{
Name: pulumi.String("CriticalAlertsAction"),
ResourceGroupName: example.Name,
ShortName: pulumi.String("p0action"),
ArmRoleReceivers: monitoring.ActionGroupArmRoleReceiverArray{
&monitoring.ActionGroupArmRoleReceiverArgs{
Name: pulumi.String("armroleaction"),
RoleId: pulumi.String("de139f84-1756-47ae-9be6-808fbbe84772"),
UseCommonAlertSchema: pulumi.Bool(true),
},
},
AutomationRunbookReceivers: monitoring.ActionGroupAutomationRunbookReceiverArray{
&monitoring.ActionGroupAutomationRunbookReceiverArgs{
Name: pulumi.String("action_name_1"),
AutomationAccountId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001"),
RunbookName: pulumi.String("my runbook"),
WebhookResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001/webHooks/webhook_alert"),
IsGlobalRunbook: pulumi.Bool(true),
ServiceUri: pulumi.String("https://s13events.azure-automation.net/webhooks?token=randomtoken"),
UseCommonAlertSchema: pulumi.Bool(true),
},
},
AzureAppPushReceivers: monitoring.ActionGroupAzureAppPushReceiverArray{
&monitoring.ActionGroupAzureAppPushReceiverArgs{
Name: pulumi.String("pushtoadmin"),
EmailAddress: pulumi.String("admin@contoso.com"),
},
},
AzureFunctionReceivers: monitoring.ActionGroupAzureFunctionReceiverArray{
&monitoring.ActionGroupAzureFunctionReceiverArgs{
Name: pulumi.String("funcaction"),
FunctionAppResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp"),
FunctionName: pulumi.String("myfunc"),
HttpTriggerUrl: pulumi.String("https://example.com/trigger"),
UseCommonAlertSchema: pulumi.Bool(true),
},
},
EmailReceivers: monitoring.ActionGroupEmailReceiverArray{
&monitoring.ActionGroupEmailReceiverArgs{
Name: pulumi.String("sendtoadmin"),
EmailAddress: pulumi.String("admin@contoso.com"),
},
&monitoring.ActionGroupEmailReceiverArgs{
Name: pulumi.String("sendtodevops"),
EmailAddress: pulumi.String("devops@contoso.com"),
UseCommonAlertSchema: pulumi.Bool(true),
},
},
EventHubReceivers: monitoring.ActionGroupEventHubReceiverArray{
&monitoring.ActionGroupEventHubReceiverArgs{
Name: pulumi.String("sendtoeventhub"),
EventHubNamespace: pulumi.String("eventhubnamespace"),
EventHubName: pulumi.String("eventhub1"),
SubscriptionId: pulumi.String("00000000-0000-0000-0000-000000000000"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
ItsmReceivers: monitoring.ActionGroupItsmReceiverArray{
&monitoring.ActionGroupItsmReceiverArgs{
Name: pulumi.String("createorupdateticket"),
WorkspaceId: exampleAnalyticsWorkspace.WorkspaceId.ApplyT(func(workspaceId string) (string, error) {
return fmt.Sprintf("%v|%v", current.SubscriptionId, workspaceId), nil
}).(pulumi.StringOutput),
ConnectionId: pulumi.String("53de6956-42b4-41ba-be3c-b154cdf17b13"),
TicketConfiguration: pulumi.String("{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}"),
Region: pulumi.String("southcentralus"),
},
},
LogicAppReceivers: monitoring.ActionGroupLogicAppReceiverArray{
&monitoring.ActionGroupLogicAppReceiverArgs{
Name: pulumi.String("logicappaction"),
ResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp"),
CallbackUrl: pulumi.String("https://logicapptriggerurl/..."),
UseCommonAlertSchema: pulumi.Bool(true),
},
},
SmsReceivers: monitoring.ActionGroupSmsReceiverArray{
&monitoring.ActionGroupSmsReceiverArgs{
Name: pulumi.String("oncallmsg"),
CountryCode: pulumi.String("1"),
PhoneNumber: pulumi.String("1231231234"),
},
},
VoiceReceivers: monitoring.ActionGroupVoiceReceiverArray{
&monitoring.ActionGroupVoiceReceiverArgs{
Name: pulumi.String("remotesupport"),
CountryCode: pulumi.String("86"),
PhoneNumber: pulumi.String("13888888888"),
},
},
WebhookReceivers: monitoring.ActionGroupWebhookReceiverArray{
&monitoring.ActionGroupWebhookReceiverArgs{
Name: pulumi.String("callmyapiaswell"),
ServiceUri: pulumi.String("http://example.com/alert"),
UseCommonAlertSchema: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "monitoring-resources",
Location = "West Europe",
});
var current = Azure.Core.GetClientConfig.Invoke();
var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
{
Name = "workspace-01",
Location = example.Location,
ResourceGroupName = example.Name,
});
var exampleActionGroup = new Azure.Monitoring.ActionGroup("example", new()
{
Name = "CriticalAlertsAction",
ResourceGroupName = example.Name,
ShortName = "p0action",
ArmRoleReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupArmRoleReceiverArgs
{
Name = "armroleaction",
RoleId = "de139f84-1756-47ae-9be6-808fbbe84772",
UseCommonAlertSchema = true,
},
},
AutomationRunbookReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupAutomationRunbookReceiverArgs
{
Name = "action_name_1",
AutomationAccountId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001",
RunbookName = "my runbook",
WebhookResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001/webHooks/webhook_alert",
IsGlobalRunbook = true,
ServiceUri = "https://s13events.azure-automation.net/webhooks?token=randomtoken",
UseCommonAlertSchema = true,
},
},
AzureAppPushReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupAzureAppPushReceiverArgs
{
Name = "pushtoadmin",
EmailAddress = "admin@contoso.com",
},
},
AzureFunctionReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupAzureFunctionReceiverArgs
{
Name = "funcaction",
FunctionAppResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp",
FunctionName = "myfunc",
HttpTriggerUrl = "https://example.com/trigger",
UseCommonAlertSchema = true,
},
},
EmailReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupEmailReceiverArgs
{
Name = "sendtoadmin",
EmailAddress = "admin@contoso.com",
},
new Azure.Monitoring.Inputs.ActionGroupEmailReceiverArgs
{
Name = "sendtodevops",
EmailAddress = "devops@contoso.com",
UseCommonAlertSchema = true,
},
},
EventHubReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupEventHubReceiverArgs
{
Name = "sendtoeventhub",
EventHubNamespace = "eventhubnamespace",
EventHubName = "eventhub1",
SubscriptionId = "00000000-0000-0000-0000-000000000000",
UseCommonAlertSchema = false,
},
},
ItsmReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupItsmReceiverArgs
{
Name = "createorupdateticket",
WorkspaceId = Output.Tuple(current, exampleAnalyticsWorkspace.WorkspaceId).Apply(values =>
{
var current = values.Item1;
var workspaceId = values.Item2;
return $"{current.Apply(getClientConfigResult => getClientConfigResult.SubscriptionId)}|{workspaceId}";
}),
ConnectionId = "53de6956-42b4-41ba-be3c-b154cdf17b13",
TicketConfiguration = "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}",
Region = "southcentralus",
},
},
LogicAppReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupLogicAppReceiverArgs
{
Name = "logicappaction",
ResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp",
CallbackUrl = "https://logicapptriggerurl/...",
UseCommonAlertSchema = true,
},
},
SmsReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupSmsReceiverArgs
{
Name = "oncallmsg",
CountryCode = "1",
PhoneNumber = "1231231234",
},
},
VoiceReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupVoiceReceiverArgs
{
Name = "remotesupport",
CountryCode = "86",
PhoneNumber = "13888888888",
},
},
WebhookReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupWebhookReceiverArgs
{
Name = "callmyapiaswell",
ServiceUri = "http://example.com/alert",
UseCommonAlertSchema = true,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.monitoring.ActionGroup;
import com.pulumi.azure.monitoring.ActionGroupArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupArmRoleReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupAutomationRunbookReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupAzureAppPushReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupAzureFunctionReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupEmailReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupEventHubReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupItsmReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupLogicAppReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupSmsReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupVoiceReceiverArgs;
import com.pulumi.azure.monitoring.inputs.ActionGroupWebhookReceiverArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("monitoring-resources")
.location("West Europe")
.build());
final var current = CoreFunctions.getClientConfig();
var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
.name("workspace-01")
.location(example.location())
.resourceGroupName(example.name())
.build());
var exampleActionGroup = new ActionGroup("exampleActionGroup", ActionGroupArgs.builder()
.name("CriticalAlertsAction")
.resourceGroupName(example.name())
.shortName("p0action")
.armRoleReceivers(ActionGroupArmRoleReceiverArgs.builder()
.name("armroleaction")
.roleId("de139f84-1756-47ae-9be6-808fbbe84772")
.useCommonAlertSchema(true)
.build())
.automationRunbookReceivers(ActionGroupAutomationRunbookReceiverArgs.builder()
.name("action_name_1")
.automationAccountId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001")
.runbookName("my runbook")
.webhookResourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001/webHooks/webhook_alert")
.isGlobalRunbook(true)
.serviceUri("https://s13events.azure-automation.net/webhooks?token=randomtoken")
.useCommonAlertSchema(true)
.build())
.azureAppPushReceivers(ActionGroupAzureAppPushReceiverArgs.builder()
.name("pushtoadmin")
.emailAddress("admin@contoso.com")
.build())
.azureFunctionReceivers(ActionGroupAzureFunctionReceiverArgs.builder()
.name("funcaction")
.functionAppResourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp")
.functionName("myfunc")
.httpTriggerUrl("https://example.com/trigger")
.useCommonAlertSchema(true)
.build())
.emailReceivers(
ActionGroupEmailReceiverArgs.builder()
.name("sendtoadmin")
.emailAddress("admin@contoso.com")
.build(),
ActionGroupEmailReceiverArgs.builder()
.name("sendtodevops")
.emailAddress("devops@contoso.com")
.useCommonAlertSchema(true)
.build())
.eventHubReceivers(ActionGroupEventHubReceiverArgs.builder()
.name("sendtoeventhub")
.eventHubNamespace("eventhubnamespace")
.eventHubName("eventhub1")
.subscriptionId("00000000-0000-0000-0000-000000000000")
.useCommonAlertSchema(false)
.build())
.itsmReceivers(ActionGroupItsmReceiverArgs.builder()
.name("createorupdateticket")
.workspaceId(exampleAnalyticsWorkspace.workspaceId().applyValue(workspaceId -> String.format("%s|%s", current.applyValue(getClientConfigResult -> getClientConfigResult.subscriptionId()),workspaceId)))
.connectionId("53de6956-42b4-41ba-be3c-b154cdf17b13")
.ticketConfiguration("{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}")
.region("southcentralus")
.build())
.logicAppReceivers(ActionGroupLogicAppReceiverArgs.builder()
.name("logicappaction")
.resourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp")
.callbackUrl("https://logicapptriggerurl/...")
.useCommonAlertSchema(true)
.build())
.smsReceivers(ActionGroupSmsReceiverArgs.builder()
.name("oncallmsg")
.countryCode("1")
.phoneNumber("1231231234")
.build())
.voiceReceivers(ActionGroupVoiceReceiverArgs.builder()
.name("remotesupport")
.countryCode("86")
.phoneNumber("13888888888")
.build())
.webhookReceivers(ActionGroupWebhookReceiverArgs.builder()
.name("callmyapiaswell")
.serviceUri("http://example.com/alert")
.useCommonAlertSchema(true)
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: monitoring-resources
location: West Europe
exampleAnalyticsWorkspace:
type: azure:operationalinsights:AnalyticsWorkspace
name: example
properties:
name: workspace-01
location: ${example.location}
resourceGroupName: ${example.name}
exampleActionGroup:
type: azure:monitoring:ActionGroup
name: example
properties:
name: CriticalAlertsAction
resourceGroupName: ${example.name}
shortName: p0action
armRoleReceivers:
- name: armroleaction
roleId: de139f84-1756-47ae-9be6-808fbbe84772
useCommonAlertSchema: true
automationRunbookReceivers:
- name: action_name_1
automationAccountId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001
runbookName: my runbook
webhookResourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-runbooks/providers/Microsoft.Automation/automationAccounts/aaa001/webHooks/webhook_alert
isGlobalRunbook: true
serviceUri: https://s13events.azure-automation.net/webhooks?token=randomtoken
useCommonAlertSchema: true
azureAppPushReceivers:
- name: pushtoadmin
emailAddress: admin@contoso.com
azureFunctionReceivers:
- name: funcaction
functionAppResourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-funcapp/providers/Microsoft.Web/sites/funcapp
functionName: myfunc
httpTriggerUrl: https://example.com/trigger
useCommonAlertSchema: true
emailReceivers:
- name: sendtoadmin
emailAddress: admin@contoso.com
- name: sendtodevops
emailAddress: devops@contoso.com
useCommonAlertSchema: true
eventHubReceivers:
- name: sendtoeventhub
eventHubNamespace: eventhubnamespace
eventHubName: eventhub1
subscriptionId: 00000000-0000-0000-0000-000000000000
useCommonAlertSchema: false
itsmReceivers:
- name: createorupdateticket
workspaceId: ${current.subscriptionId}|${exampleAnalyticsWorkspace.workspaceId}
connectionId: 53de6956-42b4-41ba-be3c-b154cdf17b13
ticketConfiguration: '{"PayloadRevision":0,"WorkItemType":"Incident","UseTemplate":false,"WorkItemData":"{}","CreateOneWIPerCI":false}'
region: southcentralus
logicAppReceivers:
- name: logicappaction
resourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-logicapp/providers/Microsoft.Logic/workflows/logicapp
callbackUrl: https://logicapptriggerurl/...
useCommonAlertSchema: true
smsReceivers:
- name: oncallmsg
countryCode: '1'
phoneNumber: '1231231234'
voiceReceivers:
- name: remotesupport
countryCode: '86'
phoneNumber: '13888888888'
webhookReceivers:
- name: callmyapiaswell
serviceUri: http://example.com/alert
useCommonAlertSchema: true
variables:
current:
fn::invoke:
function: azure:core:getClientConfig
arguments: {}
Create ActionGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ActionGroup(name: string, args: ActionGroupArgs, opts?: CustomResourceOptions);@overload
def ActionGroup(resource_name: str,
args: ActionGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ActionGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
short_name: Optional[str] = None,
email_receivers: Optional[Sequence[ActionGroupEmailReceiverArgs]] = None,
logic_app_receivers: Optional[Sequence[ActionGroupLogicAppReceiverArgs]] = None,
arm_role_receivers: Optional[Sequence[ActionGroupArmRoleReceiverArgs]] = None,
enabled: Optional[bool] = None,
event_hub_receivers: Optional[Sequence[ActionGroupEventHubReceiverArgs]] = None,
itsm_receivers: Optional[Sequence[ActionGroupItsmReceiverArgs]] = None,
location: Optional[str] = None,
azure_function_receivers: Optional[Sequence[ActionGroupAzureFunctionReceiverArgs]] = None,
name: Optional[str] = None,
azure_app_push_receivers: Optional[Sequence[ActionGroupAzureAppPushReceiverArgs]] = None,
automation_runbook_receivers: Optional[Sequence[ActionGroupAutomationRunbookReceiverArgs]] = None,
sms_receivers: Optional[Sequence[ActionGroupSmsReceiverArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
voice_receivers: Optional[Sequence[ActionGroupVoiceReceiverArgs]] = None,
webhook_receivers: Optional[Sequence[ActionGroupWebhookReceiverArgs]] = None)func NewActionGroup(ctx *Context, name string, args ActionGroupArgs, opts ...ResourceOption) (*ActionGroup, error)public ActionGroup(string name, ActionGroupArgs args, CustomResourceOptions? opts = null)public ActionGroup(String name, ActionGroupArgs args)
public ActionGroup(String name, ActionGroupArgs args, CustomResourceOptions options)
type: azure:monitoring:ActionGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ActionGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ActionGroupArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ActionGroupArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ActionGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ActionGroupArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var actionGroupResource = new Azure.Monitoring.ActionGroup("actionGroupResource", new()
{
ResourceGroupName = "string",
ShortName = "string",
EmailReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupEmailReceiverArgs
{
EmailAddress = "string",
Name = "string",
UseCommonAlertSchema = false,
},
},
LogicAppReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupLogicAppReceiverArgs
{
CallbackUrl = "string",
Name = "string",
ResourceId = "string",
UseCommonAlertSchema = false,
},
},
ArmRoleReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupArmRoleReceiverArgs
{
Name = "string",
RoleId = "string",
UseCommonAlertSchema = false,
},
},
Enabled = false,
EventHubReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupEventHubReceiverArgs
{
EventHubName = "string",
EventHubNamespace = "string",
Name = "string",
SubscriptionId = "string",
TenantId = "string",
UseCommonAlertSchema = false,
},
},
ItsmReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupItsmReceiverArgs
{
ConnectionId = "string",
Name = "string",
Region = "string",
TicketConfiguration = "string",
WorkspaceId = "string",
},
},
Location = "string",
AzureFunctionReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupAzureFunctionReceiverArgs
{
FunctionAppResourceId = "string",
FunctionName = "string",
HttpTriggerUrl = "string",
Name = "string",
UseCommonAlertSchema = false,
},
},
Name = "string",
AzureAppPushReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupAzureAppPushReceiverArgs
{
EmailAddress = "string",
Name = "string",
},
},
AutomationRunbookReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupAutomationRunbookReceiverArgs
{
AutomationAccountId = "string",
IsGlobalRunbook = false,
Name = "string",
RunbookName = "string",
ServiceUri = "string",
WebhookResourceId = "string",
UseCommonAlertSchema = false,
},
},
SmsReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupSmsReceiverArgs
{
CountryCode = "string",
Name = "string",
PhoneNumber = "string",
},
},
Tags =
{
{ "string", "string" },
},
VoiceReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupVoiceReceiverArgs
{
CountryCode = "string",
Name = "string",
PhoneNumber = "string",
},
},
WebhookReceivers = new[]
{
new Azure.Monitoring.Inputs.ActionGroupWebhookReceiverArgs
{
Name = "string",
ServiceUri = "string",
AadAuth = new Azure.Monitoring.Inputs.ActionGroupWebhookReceiverAadAuthArgs
{
ObjectId = "string",
IdentifierUri = "string",
TenantId = "string",
},
UseCommonAlertSchema = false,
},
},
});
example, err := monitoring.NewActionGroup(ctx, "actionGroupResource", &monitoring.ActionGroupArgs{
ResourceGroupName: pulumi.String("string"),
ShortName: pulumi.String("string"),
EmailReceivers: monitoring.ActionGroupEmailReceiverArray{
&monitoring.ActionGroupEmailReceiverArgs{
EmailAddress: pulumi.String("string"),
Name: pulumi.String("string"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
LogicAppReceivers: monitoring.ActionGroupLogicAppReceiverArray{
&monitoring.ActionGroupLogicAppReceiverArgs{
CallbackUrl: pulumi.String("string"),
Name: pulumi.String("string"),
ResourceId: pulumi.String("string"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
ArmRoleReceivers: monitoring.ActionGroupArmRoleReceiverArray{
&monitoring.ActionGroupArmRoleReceiverArgs{
Name: pulumi.String("string"),
RoleId: pulumi.String("string"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
Enabled: pulumi.Bool(false),
EventHubReceivers: monitoring.ActionGroupEventHubReceiverArray{
&monitoring.ActionGroupEventHubReceiverArgs{
EventHubName: pulumi.String("string"),
EventHubNamespace: pulumi.String("string"),
Name: pulumi.String("string"),
SubscriptionId: pulumi.String("string"),
TenantId: pulumi.String("string"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
ItsmReceivers: monitoring.ActionGroupItsmReceiverArray{
&monitoring.ActionGroupItsmReceiverArgs{
ConnectionId: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
TicketConfiguration: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
},
},
Location: pulumi.String("string"),
AzureFunctionReceivers: monitoring.ActionGroupAzureFunctionReceiverArray{
&monitoring.ActionGroupAzureFunctionReceiverArgs{
FunctionAppResourceId: pulumi.String("string"),
FunctionName: pulumi.String("string"),
HttpTriggerUrl: pulumi.String("string"),
Name: pulumi.String("string"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
AzureAppPushReceivers: monitoring.ActionGroupAzureAppPushReceiverArray{
&monitoring.ActionGroupAzureAppPushReceiverArgs{
EmailAddress: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
AutomationRunbookReceivers: monitoring.ActionGroupAutomationRunbookReceiverArray{
&monitoring.ActionGroupAutomationRunbookReceiverArgs{
AutomationAccountId: pulumi.String("string"),
IsGlobalRunbook: pulumi.Bool(false),
Name: pulumi.String("string"),
RunbookName: pulumi.String("string"),
ServiceUri: pulumi.String("string"),
WebhookResourceId: pulumi.String("string"),
UseCommonAlertSchema: pulumi.Bool(false),
},
},
SmsReceivers: monitoring.ActionGroupSmsReceiverArray{
&monitoring.ActionGroupSmsReceiverArgs{
CountryCode: pulumi.String("string"),
Name: pulumi.String("string"),
PhoneNumber: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VoiceReceivers: monitoring.ActionGroupVoiceReceiverArray{
&monitoring.ActionGroupVoiceReceiverArgs{
CountryCode: pulumi.String("string"),
Name: pulumi.String("string"),
PhoneNumber: pulumi.String("string"),
},
},
WebhookReceivers: monitoring.ActionGroupWebhookReceiverArray{
&monitoring.ActionGroupWebhookReceiverArgs{
Name: pulumi.String("string"),
ServiceUri: pulumi.String("string"),
AadAuth: &monitoring.ActionGroupWebhookReceiverAadAuthArgs{
ObjectId: pulumi.String("string"),
IdentifierUri: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
UseCommonAlertSchema: pulumi.Bool(false),
},
},
})
var actionGroupResource = new ActionGroup("actionGroupResource", ActionGroupArgs.builder()
.resourceGroupName("string")
.shortName("string")
.emailReceivers(ActionGroupEmailReceiverArgs.builder()
.emailAddress("string")
.name("string")
.useCommonAlertSchema(false)
.build())
.logicAppReceivers(ActionGroupLogicAppReceiverArgs.builder()
.callbackUrl("string")
.name("string")
.resourceId("string")
.useCommonAlertSchema(false)
.build())
.armRoleReceivers(ActionGroupArmRoleReceiverArgs.builder()
.name("string")
.roleId("string")
.useCommonAlertSchema(false)
.build())
.enabled(false)
.eventHubReceivers(ActionGroupEventHubReceiverArgs.builder()
.eventHubName("string")
.eventHubNamespace("string")
.name("string")
.subscriptionId("string")
.tenantId("string")
.useCommonAlertSchema(false)
.build())
.itsmReceivers(ActionGroupItsmReceiverArgs.builder()
.connectionId("string")
.name("string")
.region("string")
.ticketConfiguration("string")
.workspaceId("string")
.build())
.location("string")
.azureFunctionReceivers(ActionGroupAzureFunctionReceiverArgs.builder()
.functionAppResourceId("string")
.functionName("string")
.httpTriggerUrl("string")
.name("string")
.useCommonAlertSchema(false)
.build())
.name("string")
.azureAppPushReceivers(ActionGroupAzureAppPushReceiverArgs.builder()
.emailAddress("string")
.name("string")
.build())
.automationRunbookReceivers(ActionGroupAutomationRunbookReceiverArgs.builder()
.automationAccountId("string")
.isGlobalRunbook(false)
.name("string")
.runbookName("string")
.serviceUri("string")
.webhookResourceId("string")
.useCommonAlertSchema(false)
.build())
.smsReceivers(ActionGroupSmsReceiverArgs.builder()
.countryCode("string")
.name("string")
.phoneNumber("string")
.build())
.tags(Map.of("string", "string"))
.voiceReceivers(ActionGroupVoiceReceiverArgs.builder()
.countryCode("string")
.name("string")
.phoneNumber("string")
.build())
.webhookReceivers(ActionGroupWebhookReceiverArgs.builder()
.name("string")
.serviceUri("string")
.aadAuth(ActionGroupWebhookReceiverAadAuthArgs.builder()
.objectId("string")
.identifierUri("string")
.tenantId("string")
.build())
.useCommonAlertSchema(false)
.build())
.build());
action_group_resource = azure.monitoring.ActionGroup("actionGroupResource",
resource_group_name="string",
short_name="string",
email_receivers=[{
"email_address": "string",
"name": "string",
"use_common_alert_schema": False,
}],
logic_app_receivers=[{
"callback_url": "string",
"name": "string",
"resource_id": "string",
"use_common_alert_schema": False,
}],
arm_role_receivers=[{
"name": "string",
"role_id": "string",
"use_common_alert_schema": False,
}],
enabled=False,
event_hub_receivers=[{
"event_hub_name": "string",
"event_hub_namespace": "string",
"name": "string",
"subscription_id": "string",
"tenant_id": "string",
"use_common_alert_schema": False,
}],
itsm_receivers=[{
"connection_id": "string",
"name": "string",
"region": "string",
"ticket_configuration": "string",
"workspace_id": "string",
}],
location="string",
azure_function_receivers=[{
"function_app_resource_id": "string",
"function_name": "string",
"http_trigger_url": "string",
"name": "string",
"use_common_alert_schema": False,
}],
name="string",
azure_app_push_receivers=[{
"email_address": "string",
"name": "string",
}],
automation_runbook_receivers=[{
"automation_account_id": "string",
"is_global_runbook": False,
"name": "string",
"runbook_name": "string",
"service_uri": "string",
"webhook_resource_id": "string",
"use_common_alert_schema": False,
}],
sms_receivers=[{
"country_code": "string",
"name": "string",
"phone_number": "string",
}],
tags={
"string": "string",
},
voice_receivers=[{
"country_code": "string",
"name": "string",
"phone_number": "string",
}],
webhook_receivers=[{
"name": "string",
"service_uri": "string",
"aad_auth": {
"object_id": "string",
"identifier_uri": "string",
"tenant_id": "string",
},
"use_common_alert_schema": False,
}])
const actionGroupResource = new azure.monitoring.ActionGroup("actionGroupResource", {
resourceGroupName: "string",
shortName: "string",
emailReceivers: [{
emailAddress: "string",
name: "string",
useCommonAlertSchema: false,
}],
logicAppReceivers: [{
callbackUrl: "string",
name: "string",
resourceId: "string",
useCommonAlertSchema: false,
}],
armRoleReceivers: [{
name: "string",
roleId: "string",
useCommonAlertSchema: false,
}],
enabled: false,
eventHubReceivers: [{
eventHubName: "string",
eventHubNamespace: "string",
name: "string",
subscriptionId: "string",
tenantId: "string",
useCommonAlertSchema: false,
}],
itsmReceivers: [{
connectionId: "string",
name: "string",
region: "string",
ticketConfiguration: "string",
workspaceId: "string",
}],
location: "string",
azureFunctionReceivers: [{
functionAppResourceId: "string",
functionName: "string",
httpTriggerUrl: "string",
name: "string",
useCommonAlertSchema: false,
}],
name: "string",
azureAppPushReceivers: [{
emailAddress: "string",
name: "string",
}],
automationRunbookReceivers: [{
automationAccountId: "string",
isGlobalRunbook: false,
name: "string",
runbookName: "string",
serviceUri: "string",
webhookResourceId: "string",
useCommonAlertSchema: false,
}],
smsReceivers: [{
countryCode: "string",
name: "string",
phoneNumber: "string",
}],
tags: {
string: "string",
},
voiceReceivers: [{
countryCode: "string",
name: "string",
phoneNumber: "string",
}],
webhookReceivers: [{
name: "string",
serviceUri: "string",
aadAuth: {
objectId: "string",
identifierUri: "string",
tenantId: "string",
},
useCommonAlertSchema: false,
}],
});
type: azure:monitoring:ActionGroup
properties:
armRoleReceivers:
- name: string
roleId: string
useCommonAlertSchema: false
automationRunbookReceivers:
- automationAccountId: string
isGlobalRunbook: false
name: string
runbookName: string
serviceUri: string
useCommonAlertSchema: false
webhookResourceId: string
azureAppPushReceivers:
- emailAddress: string
name: string
azureFunctionReceivers:
- functionAppResourceId: string
functionName: string
httpTriggerUrl: string
name: string
useCommonAlertSchema: false
emailReceivers:
- emailAddress: string
name: string
useCommonAlertSchema: false
enabled: false
eventHubReceivers:
- eventHubName: string
eventHubNamespace: string
name: string
subscriptionId: string
tenantId: string
useCommonAlertSchema: false
itsmReceivers:
- connectionId: string
name: string
region: string
ticketConfiguration: string
workspaceId: string
location: string
logicAppReceivers:
- callbackUrl: string
name: string
resourceId: string
useCommonAlertSchema: false
name: string
resourceGroupName: string
shortName: string
smsReceivers:
- countryCode: string
name: string
phoneNumber: string
tags:
string: string
voiceReceivers:
- countryCode: string
name: string
phoneNumber: string
webhookReceivers:
- aadAuth:
identifierUri: string
objectId: string
tenantId: string
name: string
serviceUri: string
useCommonAlertSchema: false
ActionGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ActionGroup resource accepts the following input properties:
- Resource
Group Name stringThis property is required. 
Changes to this property will trigger replacement. - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- Short
Name This property is required. string - The short name of the action group. This will be used in SMS messages.
- Arm
Role List<ActionReceivers Group Arm Role Receiver> - One or more
arm_role_receiverblocks as defined below. - Automation
Runbook List<ActionReceivers Group Automation Runbook Receiver> - One or more
automation_runbook_receiverblocks as defined below. - Azure
App List<ActionPush Receivers Group Azure App Push Receiver> - One or more
azure_app_push_receiverblocks as defined below. - Azure
Function List<ActionReceivers Group Azure Function Receiver> - One or more
azure_function_receiverblocks as defined below. - Email
Receivers List<ActionGroup Email Receiver> - One or more
email_receiverblocks as defined below. - Enabled bool
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - Event
Hub List<ActionReceivers Group Event Hub Receiver> - One or more
event_hub_receiverblocks as defined below. - Itsm
Receivers List<ActionGroup Itsm Receiver> - One or more
itsm_receiverblocks as defined below. - Location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - Logic
App List<ActionReceivers Group Logic App Receiver> - One or more
logic_app_receiverblocks as defined below. - Name
- The name of the Action Group. Changing this forces a new resource to be created.
- Sms
Receivers List<ActionGroup Sms Receiver> - One or more
sms_receiverblocks as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Voice
Receivers List<ActionGroup Voice Receiver> - One or more
voice_receiverblocks as defined below. - Webhook
Receivers List<ActionGroup Webhook Receiver> - One or more
webhook_receiverblocks as defined below.
- Resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- Short
Name This property is required. string - The short name of the action group. This will be used in SMS messages.
- Arm
Role []ActionReceivers Group Arm Role Receiver Args - One or more
arm_role_receiverblocks as defined below. - Automation
Runbook []ActionReceivers Group Automation Runbook Receiver Args - One or more
automation_runbook_receiverblocks as defined below. - Azure
App []ActionPush Receivers Group Azure App Push Receiver Args - One or more
azure_app_push_receiverblocks as defined below. - Azure
Function []ActionReceivers Group Azure Function Receiver Args - One or more
azure_function_receiverblocks as defined below. - Email
Receivers []ActionGroup Email Receiver Args - One or more
email_receiverblocks as defined below. - Enabled bool
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - Event
Hub []ActionReceivers Group Event Hub Receiver Args - One or more
event_hub_receiverblocks as defined below. - Itsm
Receivers []ActionGroup Itsm Receiver Args - One or more
itsm_receiverblocks as defined below. - Location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - Logic
App []ActionReceivers Group Logic App Receiver Args - One or more
logic_app_receiverblocks as defined below. - Name
- The name of the Action Group. Changing this forces a new resource to be created.
- Sms
Receivers []ActionGroup Sms Receiver Args - One or more
sms_receiverblocks as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- Voice
Receivers []ActionGroup Voice Receiver Args - One or more
voice_receiverblocks as defined below. - Webhook
Receivers []ActionGroup Webhook Receiver Args - One or more
webhook_receiverblocks as defined below.
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short
Name This property is required. String - The short name of the action group. This will be used in SMS messages.
- arm
Role List<ActionReceivers Group Arm Role Receiver> - One or more
arm_role_receiverblocks as defined below. - automation
Runbook List<ActionReceivers Group Automation Runbook Receiver> - One or more
automation_runbook_receiverblocks as defined below. - azure
App List<ActionPush Receivers Group Azure App Push Receiver> - One or more
azure_app_push_receiverblocks as defined below. - azure
Function List<ActionReceivers Group Azure Function Receiver> - One or more
azure_function_receiverblocks as defined below. - email
Receivers List<ActionGroup Email Receiver> - One or more
email_receiverblocks as defined below. - enabled Boolean
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event
Hub List<ActionReceivers Group Event Hub Receiver> - One or more
event_hub_receiverblocks as defined below. - itsm
Receivers List<ActionGroup Itsm Receiver> - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic
App List<ActionReceivers Group Logic App Receiver> - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- sms
Receivers List<ActionGroup Sms Receiver> - One or more
sms_receiverblocks as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- voice
Receivers List<ActionGroup Voice Receiver> - One or more
voice_receiverblocks as defined below. - webhook
Receivers List<ActionGroup Webhook Receiver> - One or more
webhook_receiverblocks as defined below.
- resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short
Name This property is required. string - The short name of the action group. This will be used in SMS messages.
- arm
Role ActionReceivers Group Arm Role Receiver[] - One or more
arm_role_receiverblocks as defined below. - automation
Runbook ActionReceivers Group Automation Runbook Receiver[] - One or more
automation_runbook_receiverblocks as defined below. - azure
App ActionPush Receivers Group Azure App Push Receiver[] - One or more
azure_app_push_receiverblocks as defined below. - azure
Function ActionReceivers Group Azure Function Receiver[] - One or more
azure_function_receiverblocks as defined below. - email
Receivers ActionGroup Email Receiver[] - One or more
email_receiverblocks as defined below. - enabled boolean
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event
Hub ActionReceivers Group Event Hub Receiver[] - One or more
event_hub_receiverblocks as defined below. - itsm
Receivers ActionGroup Itsm Receiver[] - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic
App ActionReceivers Group Logic App Receiver[] - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- sms
Receivers ActionGroup Sms Receiver[] - One or more
sms_receiverblocks as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- voice
Receivers ActionGroup Voice Receiver[] - One or more
voice_receiverblocks as defined below. - webhook
Receivers ActionGroup Webhook Receiver[] - One or more
webhook_receiverblocks as defined below.
- resource_
group_ name strThis property is required. Changes to this property will trigger replacement. - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short_
name This property is required. str - The short name of the action group. This will be used in SMS messages.
- arm_
role_ Sequence[Actionreceivers Group Arm Role Receiver Args] - One or more
arm_role_receiverblocks as defined below. - automation_
runbook_ Sequence[Actionreceivers Group Automation Runbook Receiver Args] - One or more
automation_runbook_receiverblocks as defined below. - azure_
app_ Sequence[Actionpush_ receivers Group Azure App Push Receiver Args] - One or more
azure_app_push_receiverblocks as defined below. - azure_
function_ Sequence[Actionreceivers Group Azure Function Receiver Args] - One or more
azure_function_receiverblocks as defined below. - email_
receivers Sequence[ActionGroup Email Receiver Args] - One or more
email_receiverblocks as defined below. - enabled bool
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event_
hub_ Sequence[Actionreceivers Group Event Hub Receiver Args] - One or more
event_hub_receiverblocks as defined below. - itsm_
receivers Sequence[ActionGroup Itsm Receiver Args] - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic_
app_ Sequence[Actionreceivers Group Logic App Receiver Args] - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- sms_
receivers Sequence[ActionGroup Sms Receiver Args] - One or more
sms_receiverblocks as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- voice_
receivers Sequence[ActionGroup Voice Receiver Args] - One or more
voice_receiverblocks as defined below. - webhook_
receivers Sequence[ActionGroup Webhook Receiver Args] - One or more
webhook_receiverblocks as defined below.
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short
Name This property is required. String - The short name of the action group. This will be used in SMS messages.
- arm
Role List<Property Map>Receivers - One or more
arm_role_receiverblocks as defined below. - automation
Runbook List<Property Map>Receivers - One or more
automation_runbook_receiverblocks as defined below. - azure
App List<Property Map>Push Receivers - One or more
azure_app_push_receiverblocks as defined below. - azure
Function List<Property Map>Receivers - One or more
azure_function_receiverblocks as defined below. - email
Receivers List<Property Map> - One or more
email_receiverblocks as defined below. - enabled Boolean
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event
Hub List<Property Map>Receivers - One or more
event_hub_receiverblocks as defined below. - itsm
Receivers List<Property Map> - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic
App List<Property Map>Receivers - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- sms
Receivers List<Property Map> - One or more
sms_receiverblocks as defined below. - Map<String>
- A mapping of tags to assign to the resource.
- voice
Receivers List<Property Map> - One or more
voice_receiverblocks as defined below. - webhook
Receivers List<Property Map> - One or more
webhook_receiverblocks as defined below.
Outputs
All input properties are implicitly available as output properties. Additionally, the ActionGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ActionGroup Resource
Get an existing ActionGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ActionGroupState, opts?: CustomResourceOptions): ActionGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arm_role_receivers: Optional[Sequence[ActionGroupArmRoleReceiverArgs]] = None,
automation_runbook_receivers: Optional[Sequence[ActionGroupAutomationRunbookReceiverArgs]] = None,
azure_app_push_receivers: Optional[Sequence[ActionGroupAzureAppPushReceiverArgs]] = None,
azure_function_receivers: Optional[Sequence[ActionGroupAzureFunctionReceiverArgs]] = None,
email_receivers: Optional[Sequence[ActionGroupEmailReceiverArgs]] = None,
enabled: Optional[bool] = None,
event_hub_receivers: Optional[Sequence[ActionGroupEventHubReceiverArgs]] = None,
itsm_receivers: Optional[Sequence[ActionGroupItsmReceiverArgs]] = None,
location: Optional[str] = None,
logic_app_receivers: Optional[Sequence[ActionGroupLogicAppReceiverArgs]] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
short_name: Optional[str] = None,
sms_receivers: Optional[Sequence[ActionGroupSmsReceiverArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
voice_receivers: Optional[Sequence[ActionGroupVoiceReceiverArgs]] = None,
webhook_receivers: Optional[Sequence[ActionGroupWebhookReceiverArgs]] = None) -> ActionGroupfunc GetActionGroup(ctx *Context, name string, id IDInput, state *ActionGroupState, opts ...ResourceOption) (*ActionGroup, error)public static ActionGroup Get(string name, Input<string> id, ActionGroupState? state, CustomResourceOptions? opts = null)public static ActionGroup get(String name, Output<String> id, ActionGroupState state, CustomResourceOptions options)resources: _: type: azure:monitoring:ActionGroup get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Arm
Role List<ActionReceivers Group Arm Role Receiver> - One or more
arm_role_receiverblocks as defined below. - Automation
Runbook List<ActionReceivers Group Automation Runbook Receiver> - One or more
automation_runbook_receiverblocks as defined below. - Azure
App List<ActionPush Receivers Group Azure App Push Receiver> - One or more
azure_app_push_receiverblocks as defined below. - Azure
Function List<ActionReceivers Group Azure Function Receiver> - One or more
azure_function_receiverblocks as defined below. - Email
Receivers List<ActionGroup Email Receiver> - One or more
email_receiverblocks as defined below. - Enabled bool
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - Event
Hub List<ActionReceivers Group Event Hub Receiver> - One or more
event_hub_receiverblocks as defined below. - Itsm
Receivers List<ActionGroup Itsm Receiver> - One or more
itsm_receiverblocks as defined below. - Location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - Logic
App List<ActionReceivers Group Logic App Receiver> - One or more
logic_app_receiverblocks as defined below. - Name
- The name of the Action Group. Changing this forces a new resource to be created.
- Resource
Group Name - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- Short
Name string - The short name of the action group. This will be used in SMS messages.
- Sms
Receivers List<ActionGroup Sms Receiver> - One or more
sms_receiverblocks as defined below. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Voice
Receivers List<ActionGroup Voice Receiver> - One or more
voice_receiverblocks as defined below. - Webhook
Receivers List<ActionGroup Webhook Receiver> - One or more
webhook_receiverblocks as defined below.
- Arm
Role []ActionReceivers Group Arm Role Receiver Args - One or more
arm_role_receiverblocks as defined below. - Automation
Runbook []ActionReceivers Group Automation Runbook Receiver Args - One or more
automation_runbook_receiverblocks as defined below. - Azure
App []ActionPush Receivers Group Azure App Push Receiver Args - One or more
azure_app_push_receiverblocks as defined below. - Azure
Function []ActionReceivers Group Azure Function Receiver Args - One or more
azure_function_receiverblocks as defined below. - Email
Receivers []ActionGroup Email Receiver Args - One or more
email_receiverblocks as defined below. - Enabled bool
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - Event
Hub []ActionReceivers Group Event Hub Receiver Args - One or more
event_hub_receiverblocks as defined below. - Itsm
Receivers []ActionGroup Itsm Receiver Args - One or more
itsm_receiverblocks as defined below. - Location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - Logic
App []ActionReceivers Group Logic App Receiver Args - One or more
logic_app_receiverblocks as defined below. - Name
- The name of the Action Group. Changing this forces a new resource to be created.
- Resource
Group Name - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- Short
Name string - The short name of the action group. This will be used in SMS messages.
- Sms
Receivers []ActionGroup Sms Receiver Args - One or more
sms_receiverblocks as defined below. - map[string]string
- A mapping of tags to assign to the resource.
- Voice
Receivers []ActionGroup Voice Receiver Args - One or more
voice_receiverblocks as defined below. - Webhook
Receivers []ActionGroup Webhook Receiver Args - One or more
webhook_receiverblocks as defined below.
- arm
Role List<ActionReceivers Group Arm Role Receiver> - One or more
arm_role_receiverblocks as defined below. - automation
Runbook List<ActionReceivers Group Automation Runbook Receiver> - One or more
automation_runbook_receiverblocks as defined below. - azure
App List<ActionPush Receivers Group Azure App Push Receiver> - One or more
azure_app_push_receiverblocks as defined below. - azure
Function List<ActionReceivers Group Azure Function Receiver> - One or more
azure_function_receiverblocks as defined below. - email
Receivers List<ActionGroup Email Receiver> - One or more
email_receiverblocks as defined below. - enabled Boolean
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event
Hub List<ActionReceivers Group Event Hub Receiver> - One or more
event_hub_receiverblocks as defined below. - itsm
Receivers List<ActionGroup Itsm Receiver> - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic
App List<ActionReceivers Group Logic App Receiver> - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- resource
Group Name - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short
Name String - The short name of the action group. This will be used in SMS messages.
- sms
Receivers List<ActionGroup Sms Receiver> - One or more
sms_receiverblocks as defined below. - Map<String,String>
- A mapping of tags to assign to the resource.
- voice
Receivers List<ActionGroup Voice Receiver> - One or more
voice_receiverblocks as defined below. - webhook
Receivers List<ActionGroup Webhook Receiver> - One or more
webhook_receiverblocks as defined below.
- arm
Role ActionReceivers Group Arm Role Receiver[] - One or more
arm_role_receiverblocks as defined below. - automation
Runbook ActionReceivers Group Automation Runbook Receiver[] - One or more
automation_runbook_receiverblocks as defined below. - azure
App ActionPush Receivers Group Azure App Push Receiver[] - One or more
azure_app_push_receiverblocks as defined below. - azure
Function ActionReceivers Group Azure Function Receiver[] - One or more
azure_function_receiverblocks as defined below. - email
Receivers ActionGroup Email Receiver[] - One or more
email_receiverblocks as defined below. - enabled boolean
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event
Hub ActionReceivers Group Event Hub Receiver[] - One or more
event_hub_receiverblocks as defined below. - itsm
Receivers ActionGroup Itsm Receiver[] - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic
App ActionReceivers Group Logic App Receiver[] - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- resource
Group Name - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short
Name string - The short name of the action group. This will be used in SMS messages.
- sms
Receivers ActionGroup Sms Receiver[] - One or more
sms_receiverblocks as defined below. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- voice
Receivers ActionGroup Voice Receiver[] - One or more
voice_receiverblocks as defined below. - webhook
Receivers ActionGroup Webhook Receiver[] - One or more
webhook_receiverblocks as defined below.
- arm_
role_ Sequence[Actionreceivers Group Arm Role Receiver Args] - One or more
arm_role_receiverblocks as defined below. - automation_
runbook_ Sequence[Actionreceivers Group Automation Runbook Receiver Args] - One or more
automation_runbook_receiverblocks as defined below. - azure_
app_ Sequence[Actionpush_ receivers Group Azure App Push Receiver Args] - One or more
azure_app_push_receiverblocks as defined below. - azure_
function_ Sequence[Actionreceivers Group Azure Function Receiver Args] - One or more
azure_function_receiverblocks as defined below. - email_
receivers Sequence[ActionGroup Email Receiver Args] - One or more
email_receiverblocks as defined below. - enabled bool
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event_
hub_ Sequence[Actionreceivers Group Event Hub Receiver Args] - One or more
event_hub_receiverblocks as defined below. - itsm_
receivers Sequence[ActionGroup Itsm Receiver Args] - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic_
app_ Sequence[Actionreceivers Group Logic App Receiver Args] - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- resource_
group_ name - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short_
name str - The short name of the action group. This will be used in SMS messages.
- sms_
receivers Sequence[ActionGroup Sms Receiver Args] - One or more
sms_receiverblocks as defined below. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- voice_
receivers Sequence[ActionGroup Voice Receiver Args] - One or more
voice_receiverblocks as defined below. - webhook_
receivers Sequence[ActionGroup Webhook Receiver Args] - One or more
webhook_receiverblocks as defined below.
- arm
Role List<Property Map>Receivers - One or more
arm_role_receiverblocks as defined below. - automation
Runbook List<Property Map>Receivers - One or more
automation_runbook_receiverblocks as defined below. - azure
App List<Property Map>Push Receivers - One or more
azure_app_push_receiverblocks as defined below. - azure
Function List<Property Map>Receivers - One or more
azure_function_receiverblocks as defined below. - email
Receivers List<Property Map> - One or more
email_receiverblocks as defined below. - enabled Boolean
- Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to
true. - event
Hub List<Property Map>Receivers - One or more
event_hub_receiverblocks as defined below. - itsm
Receivers List<Property Map> - One or more
itsm_receiverblocks as defined below. - location
- The Azure Region where the Action Group should exist. Changing this forces a new Action Group to be created. Defaults to
global. - logic
App List<Property Map>Receivers - One or more
logic_app_receiverblocks as defined below. - name
- The name of the Action Group. Changing this forces a new resource to be created.
- resource
Group Name - The name of the resource group in which to create the Action Group instance. Changing this forces a new resource to be created.
- short
Name String - The short name of the action group. This will be used in SMS messages.
- sms
Receivers List<Property Map> - One or more
sms_receiverblocks as defined below. - Map<String>
- A mapping of tags to assign to the resource.
- voice
Receivers List<Property Map> - One or more
voice_receiverblocks as defined below. - webhook
Receivers List<Property Map> - One or more
webhook_receiverblocks as defined below.
Supporting Types
ActionGroupArmRoleReceiver, ActionGroupArmRoleReceiverArgs
, ActionGroupArmRoleReceiverArgs
- Name
This property is required. string - The name of the ARM role receiver.
- Role
Id This property is required. string - The arm role id.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- Name
This property is required. string - The name of the ARM role receiver.
- Role
Id This property is required. string - The arm role id.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- name
This property is required. String - The name of the ARM role receiver.
- role
Id This property is required. String - The arm role id.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
- name
This property is required. string - The name of the ARM role receiver.
- role
Id This property is required. string - The arm role id.
- use
Common booleanAlert Schema - Enables or disables the common alert schema.
- name
This property is required. str - The name of the ARM role receiver.
- role_
id This property is required. str - The arm role id.
- use_
common_ boolalert_ schema - Enables or disables the common alert schema.
- name
This property is required. String - The name of the ARM role receiver.
- role
Id This property is required. String - The arm role id.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
ActionGroupAutomationRunbookReceiver, ActionGroupAutomationRunbookReceiverArgs
, ActionGroupAutomationRunbookReceiverArgs
- Automation
Account Id This property is required. string - The automation account ID which holds this runbook and authenticates to Azure resources.
- Is
Global Runbook This property is required. bool - Indicates whether this instance is global runbook.
- Name
This property is required. string - The name of the automation runbook receiver.
- Runbook
Name This property is required. string - The name for this runbook.
- Service
Uri This property is required. string - The URI where webhooks should be sent.
- Webhook
Resource Id This property is required. string - The resource id for webhook linked to this runbook.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- Automation
Account Id This property is required. string - The automation account ID which holds this runbook and authenticates to Azure resources.
- Is
Global Runbook This property is required. bool - Indicates whether this instance is global runbook.
- Name
This property is required. string - The name of the automation runbook receiver.
- Runbook
Name This property is required. string - The name for this runbook.
- Service
Uri This property is required. string - The URI where webhooks should be sent.
- Webhook
Resource Id This property is required. string - The resource id for webhook linked to this runbook.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- automation
Account Id This property is required. String - The automation account ID which holds this runbook and authenticates to Azure resources.
- is
Global Runbook This property is required. Boolean - Indicates whether this instance is global runbook.
- name
This property is required. String - The name of the automation runbook receiver.
- runbook
Name This property is required. String - The name for this runbook.
- service
Uri This property is required. String - The URI where webhooks should be sent.
- webhook
Resource Id This property is required. String - The resource id for webhook linked to this runbook.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
- automation
Account Id This property is required. string - The automation account ID which holds this runbook and authenticates to Azure resources.
- is
Global Runbook This property is required. boolean - Indicates whether this instance is global runbook.
- name
This property is required. string - The name of the automation runbook receiver.
- runbook
Name This property is required. string - The name for this runbook.
- service
Uri This property is required. string - The URI where webhooks should be sent.
- webhook
Resource Id This property is required. string - The resource id for webhook linked to this runbook.
- use
Common booleanAlert Schema - Enables or disables the common alert schema.
- automation_
account_ id This property is required. str - The automation account ID which holds this runbook and authenticates to Azure resources.
- is_
global_ runbook This property is required. bool - Indicates whether this instance is global runbook.
- name
This property is required. str - The name of the automation runbook receiver.
- runbook_
name This property is required. str - The name for this runbook.
- service_
uri This property is required. str - The URI where webhooks should be sent.
- webhook_
resource_ id This property is required. str - The resource id for webhook linked to this runbook.
- use_
common_ boolalert_ schema - Enables or disables the common alert schema.
- automation
Account Id This property is required. String - The automation account ID which holds this runbook and authenticates to Azure resources.
- is
Global Runbook This property is required. Boolean - Indicates whether this instance is global runbook.
- name
This property is required. String - The name of the automation runbook receiver.
- runbook
Name This property is required. String - The name for this runbook.
- service
Uri This property is required. String - The URI where webhooks should be sent.
- webhook
Resource Id This property is required. String - The resource id for webhook linked to this runbook.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
ActionGroupAzureAppPushReceiver, ActionGroupAzureAppPushReceiverArgs
, ActionGroupAzureAppPushReceiverArgs
- Email
Address This property is required. string - The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- Name
This property is required. string - The name of the Azure app push receiver.
- Email
Address This property is required. string - The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- Name
This property is required. string - The name of the Azure app push receiver.
- email
Address This property is required. String - The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- name
This property is required. String - The name of the Azure app push receiver.
- email
Address This property is required. string - The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- name
This property is required. string - The name of the Azure app push receiver.
- email_
address This property is required. str - The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- name
This property is required. str - The name of the Azure app push receiver.
- email
Address This property is required. String - The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- name
This property is required. String - The name of the Azure app push receiver.
ActionGroupAzureFunctionReceiver, ActionGroupAzureFunctionReceiverArgs
, ActionGroupAzureFunctionReceiverArgs
- Function
App Resource Id This property is required. string - The Azure resource ID of the function app.
- Function
Name This property is required. string - The function name in the function app.
- Http
Trigger Url This property is required. string - The HTTP trigger url where HTTP request sent to.
- Name
This property is required. string - The name of the Azure Function receiver.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- Function
App Resource Id This property is required. string - The Azure resource ID of the function app.
- Function
Name This property is required. string - The function name in the function app.
- Http
Trigger Url This property is required. string - The HTTP trigger url where HTTP request sent to.
- Name
This property is required. string - The name of the Azure Function receiver.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- function
App Resource Id This property is required. String - The Azure resource ID of the function app.
- function
Name This property is required. String - The function name in the function app.
- http
Trigger Url This property is required. String - The HTTP trigger url where HTTP request sent to.
- name
This property is required. String - The name of the Azure Function receiver.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
- function
App Resource Id This property is required. string - The Azure resource ID of the function app.
- function
Name This property is required. string - The function name in the function app.
- http
Trigger Url This property is required. string - The HTTP trigger url where HTTP request sent to.
- name
This property is required. string - The name of the Azure Function receiver.
- use
Common booleanAlert Schema - Enables or disables the common alert schema.
- function_
app_ resource_ id This property is required. str - The Azure resource ID of the function app.
- function_
name This property is required. str - The function name in the function app.
- http_
trigger_ url This property is required. str - The HTTP trigger url where HTTP request sent to.
- name
This property is required. str - The name of the Azure Function receiver.
- use_
common_ boolalert_ schema - Enables or disables the common alert schema.
- function
App Resource Id This property is required. String - The Azure resource ID of the function app.
- function
Name This property is required. String - The function name in the function app.
- http
Trigger Url This property is required. String - The HTTP trigger url where HTTP request sent to.
- name
This property is required. String - The name of the Azure Function receiver.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
ActionGroupEmailReceiver, ActionGroupEmailReceiverArgs
, ActionGroupEmailReceiverArgs
- Email
Address This property is required. string - The email address of this receiver.
- Name
This property is required. string - The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- Email
Address This property is required. string - The email address of this receiver.
- Name
This property is required. string - The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- email
Address This property is required. String - The email address of this receiver.
- name
This property is required. String - The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
- email
Address This property is required. string - The email address of this receiver.
- name
This property is required. string - The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- use
Common booleanAlert Schema - Enables or disables the common alert schema.
- email_
address This property is required. str - The email address of this receiver.
- name
This property is required. str - The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- use_
common_ boolalert_ schema - Enables or disables the common alert schema.
- email
Address This property is required. String - The email address of this receiver.
- name
This property is required. String - The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
ActionGroupEventHubReceiver, ActionGroupEventHubReceiverArgs
, ActionGroupEventHubReceiverArgs
- Event
Hub Name This property is required. string - The name of the specific Event Hub queue.
- Event
Hub Namespace This property is required. string - The namespace name of the Event Hub.
- Name
This property is required. string - The name of the EventHub Receiver, must be unique within action group.
- Subscription
Id string - The ID for the subscription containing this Event Hub. Default to the subscription ID of the Action Group.
- Tenant
Id string - The Tenant ID for the subscription containing this Event Hub.
- Use
Common boolAlert Schema - Indicates whether to use common alert schema.
- Event
Hub Name This property is required. string - The name of the specific Event Hub queue.
- Event
Hub Namespace This property is required. string - The namespace name of the Event Hub.
- Name
This property is required. string - The name of the EventHub Receiver, must be unique within action group.
- Subscription
Id string - The ID for the subscription containing this Event Hub. Default to the subscription ID of the Action Group.
- Tenant
Id string - The Tenant ID for the subscription containing this Event Hub.
- Use
Common boolAlert Schema - Indicates whether to use common alert schema.
- event
Hub Name This property is required. String - The name of the specific Event Hub queue.
- event
Hub Namespace This property is required. String - The namespace name of the Event Hub.
- name
This property is required. String - The name of the EventHub Receiver, must be unique within action group.
- subscription
Id String - The ID for the subscription containing this Event Hub. Default to the subscription ID of the Action Group.
- tenant
Id String - The Tenant ID for the subscription containing this Event Hub.
- use
Common BooleanAlert Schema - Indicates whether to use common alert schema.
- event
Hub Name This property is required. string - The name of the specific Event Hub queue.
- event
Hub Namespace This property is required. string - The namespace name of the Event Hub.
- name
This property is required. string - The name of the EventHub Receiver, must be unique within action group.
- subscription
Id string - The ID for the subscription containing this Event Hub. Default to the subscription ID of the Action Group.
- tenant
Id string - The Tenant ID for the subscription containing this Event Hub.
- use
Common booleanAlert Schema - Indicates whether to use common alert schema.
- event_
hub_ name This property is required. str - The name of the specific Event Hub queue.
- event_
hub_ namespace This property is required. str - The namespace name of the Event Hub.
- name
This property is required. str - The name of the EventHub Receiver, must be unique within action group.
- subscription_
id str - The ID for the subscription containing this Event Hub. Default to the subscription ID of the Action Group.
- tenant_
id str - The Tenant ID for the subscription containing this Event Hub.
- use_
common_ boolalert_ schema - Indicates whether to use common alert schema.
- event
Hub Name This property is required. String - The name of the specific Event Hub queue.
- event
Hub Namespace This property is required. String - The namespace name of the Event Hub.
- name
This property is required. String - The name of the EventHub Receiver, must be unique within action group.
- subscription
Id String - The ID for the subscription containing this Event Hub. Default to the subscription ID of the Action Group.
- tenant
Id String - The Tenant ID for the subscription containing this Event Hub.
- use
Common BooleanAlert Schema - Indicates whether to use common alert schema.
ActionGroupItsmReceiver, ActionGroupItsmReceiverArgs
, ActionGroupItsmReceiverArgs
- Connection
Id This property is required. string - The unique connection identifier of the ITSM connection.
- Name
This property is required. string - The name of the ITSM receiver.
- Region
This property is required. string The region of the workspace.
NOTE
ticket_configurationshould be JSON blob withPayloadRevisionandWorkItemTypekeys (e.g.,ticket_configuration="{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\"}"), andticket_configuration="{}"will return an error, see more at this REST API issue- Ticket
Configuration This property is required. string - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- Workspace
Id This property is required. string - The Azure Log Analytics workspace ID where this connection is defined. Format is
<subscription id>|<workspace id>, for example00000000-0000-0000-0000-000000000000|00000000-0000-0000-0000-000000000000.
- Connection
Id This property is required. string - The unique connection identifier of the ITSM connection.
- Name
This property is required. string - The name of the ITSM receiver.
- Region
This property is required. string The region of the workspace.
NOTE
ticket_configurationshould be JSON blob withPayloadRevisionandWorkItemTypekeys (e.g.,ticket_configuration="{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\"}"), andticket_configuration="{}"will return an error, see more at this REST API issue- Ticket
Configuration This property is required. string - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- Workspace
Id This property is required. string - The Azure Log Analytics workspace ID where this connection is defined. Format is
<subscription id>|<workspace id>, for example00000000-0000-0000-0000-000000000000|00000000-0000-0000-0000-000000000000.
- connection
Id This property is required. String - The unique connection identifier of the ITSM connection.
- name
This property is required. String - The name of the ITSM receiver.
- region
This property is required. String The region of the workspace.
NOTE
ticket_configurationshould be JSON blob withPayloadRevisionandWorkItemTypekeys (e.g.,ticket_configuration="{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\"}"), andticket_configuration="{}"will return an error, see more at this REST API issue- ticket
Configuration This property is required. String - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- workspace
Id This property is required. String - The Azure Log Analytics workspace ID where this connection is defined. Format is
<subscription id>|<workspace id>, for example00000000-0000-0000-0000-000000000000|00000000-0000-0000-0000-000000000000.
- connection
Id This property is required. string - The unique connection identifier of the ITSM connection.
- name
This property is required. string - The name of the ITSM receiver.
- region
This property is required. string The region of the workspace.
NOTE
ticket_configurationshould be JSON blob withPayloadRevisionandWorkItemTypekeys (e.g.,ticket_configuration="{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\"}"), andticket_configuration="{}"will return an error, see more at this REST API issue- ticket
Configuration This property is required. string - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- workspace
Id This property is required. string - The Azure Log Analytics workspace ID where this connection is defined. Format is
<subscription id>|<workspace id>, for example00000000-0000-0000-0000-000000000000|00000000-0000-0000-0000-000000000000.
- connection_
id This property is required. str - The unique connection identifier of the ITSM connection.
- name
This property is required. str - The name of the ITSM receiver.
- region
This property is required. str The region of the workspace.
NOTE
ticket_configurationshould be JSON blob withPayloadRevisionandWorkItemTypekeys (e.g.,ticket_configuration="{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\"}"), andticket_configuration="{}"will return an error, see more at this REST API issue- ticket_
configuration This property is required. str - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- workspace_
id This property is required. str - The Azure Log Analytics workspace ID where this connection is defined. Format is
<subscription id>|<workspace id>, for example00000000-0000-0000-0000-000000000000|00000000-0000-0000-0000-000000000000.
- connection
Id This property is required. String - The unique connection identifier of the ITSM connection.
- name
This property is required. String - The name of the ITSM receiver.
- region
This property is required. String The region of the workspace.
NOTE
ticket_configurationshould be JSON blob withPayloadRevisionandWorkItemTypekeys (e.g.,ticket_configuration="{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\"}"), andticket_configuration="{}"will return an error, see more at this REST API issue- ticket
Configuration This property is required. String - A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- workspace
Id This property is required. String - The Azure Log Analytics workspace ID where this connection is defined. Format is
<subscription id>|<workspace id>, for example00000000-0000-0000-0000-000000000000|00000000-0000-0000-0000-000000000000.
ActionGroupLogicAppReceiver, ActionGroupLogicAppReceiverArgs
, ActionGroupLogicAppReceiverArgs
- Callback
Url This property is required. string - The callback url where HTTP request sent to.
- Name
This property is required. string - The name of the logic app receiver.
- Resource
Id This property is required. string - The Azure resource ID of the logic app.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- Callback
Url This property is required. string - The callback url where HTTP request sent to.
- Name
This property is required. string - The name of the logic app receiver.
- Resource
Id This property is required. string - The Azure resource ID of the logic app.
- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- callback
Url This property is required. String - The callback url where HTTP request sent to.
- name
This property is required. String - The name of the logic app receiver.
- resource
Id This property is required. String - The Azure resource ID of the logic app.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
- callback
Url This property is required. string - The callback url where HTTP request sent to.
- name
This property is required. string - The name of the logic app receiver.
- resource
Id This property is required. string - The Azure resource ID of the logic app.
- use
Common booleanAlert Schema - Enables or disables the common alert schema.
- callback_
url This property is required. str - The callback url where HTTP request sent to.
- name
This property is required. str - The name of the logic app receiver.
- resource_
id This property is required. str - The Azure resource ID of the logic app.
- use_
common_ boolalert_ schema - Enables or disables the common alert schema.
- callback
Url This property is required. String - The callback url where HTTP request sent to.
- name
This property is required. String - The name of the logic app receiver.
- resource
Id This property is required. String - The Azure resource ID of the logic app.
- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
ActionGroupSmsReceiver, ActionGroupSmsReceiverArgs
, ActionGroupSmsReceiverArgs
- Country
Code This property is required. string - The country code of the SMS receiver.
- Name
This property is required. string - The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Phone
Number This property is required. string - The phone number of the SMS receiver.
- Country
Code This property is required. string - The country code of the SMS receiver.
- Name
This property is required. string - The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Phone
Number This property is required. string - The phone number of the SMS receiver.
- country
Code This property is required. String - The country code of the SMS receiver.
- name
This property is required. String - The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- phone
Number This property is required. String - The phone number of the SMS receiver.
- country
Code This property is required. string - The country code of the SMS receiver.
- name
This property is required. string - The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- phone
Number This property is required. string - The phone number of the SMS receiver.
- country_
code This property is required. str - The country code of the SMS receiver.
- name
This property is required. str - The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- phone_
number This property is required. str - The phone number of the SMS receiver.
- country
Code This property is required. String - The country code of the SMS receiver.
- name
This property is required. String - The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- phone
Number This property is required. String - The phone number of the SMS receiver.
ActionGroupVoiceReceiver, ActionGroupVoiceReceiverArgs
, ActionGroupVoiceReceiverArgs
- Country
Code This property is required. string - The country code of the voice receiver.
- Name
This property is required. string - The name of the voice receiver.
- Phone
Number This property is required. string - The phone number of the voice receiver.
- Country
Code This property is required. string - The country code of the voice receiver.
- Name
This property is required. string - The name of the voice receiver.
- Phone
Number This property is required. string - The phone number of the voice receiver.
- country
Code This property is required. String - The country code of the voice receiver.
- name
This property is required. String - The name of the voice receiver.
- phone
Number This property is required. String - The phone number of the voice receiver.
- country
Code This property is required. string - The country code of the voice receiver.
- name
This property is required. string - The name of the voice receiver.
- phone
Number This property is required. string - The phone number of the voice receiver.
- country_
code This property is required. str - The country code of the voice receiver.
- name
This property is required. str - The name of the voice receiver.
- phone_
number This property is required. str - The phone number of the voice receiver.
- country
Code This property is required. String - The country code of the voice receiver.
- name
This property is required. String - The name of the voice receiver.
- phone
Number This property is required. String - The phone number of the voice receiver.
ActionGroupWebhookReceiver, ActionGroupWebhookReceiverArgs
, ActionGroupWebhookReceiverArgs
- Name
This property is required. string - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Service
Uri This property is required. string - The URI where webhooks should be sent.
- Aad
Auth ActionGroup Webhook Receiver Aad Auth The
aad_authblock as defined below.NOTE: Before adding a secure webhook receiver by setting
aad_auth, please read the configuration instruction of the AAD application.- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- Name
This property is required. string - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Service
Uri This property is required. string - The URI where webhooks should be sent.
- Aad
Auth ActionGroup Webhook Receiver Aad Auth The
aad_authblock as defined below.NOTE: Before adding a secure webhook receiver by setting
aad_auth, please read the configuration instruction of the AAD application.- Use
Common boolAlert Schema - Enables or disables the common alert schema.
- name
This property is required. String - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- service
Uri This property is required. String - The URI where webhooks should be sent.
- aad
Auth ActionGroup Webhook Receiver Aad Auth The
aad_authblock as defined below.NOTE: Before adding a secure webhook receiver by setting
aad_auth, please read the configuration instruction of the AAD application.- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
- name
This property is required. string - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- service
Uri This property is required. string - The URI where webhooks should be sent.
- aad
Auth ActionGroup Webhook Receiver Aad Auth The
aad_authblock as defined below.NOTE: Before adding a secure webhook receiver by setting
aad_auth, please read the configuration instruction of the AAD application.- use
Common booleanAlert Schema - Enables or disables the common alert schema.
- name
This property is required. str - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- service_
uri This property is required. str - The URI where webhooks should be sent.
- aad_
auth ActionGroup Webhook Receiver Aad Auth The
aad_authblock as defined below.NOTE: Before adding a secure webhook receiver by setting
aad_auth, please read the configuration instruction of the AAD application.- use_
common_ boolalert_ schema - Enables or disables the common alert schema.
- name
This property is required. String - The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- service
Uri This property is required. String - The URI where webhooks should be sent.
- aad
Auth Property Map The
aad_authblock as defined below.NOTE: Before adding a secure webhook receiver by setting
aad_auth, please read the configuration instruction of the AAD application.- use
Common BooleanAlert Schema - Enables or disables the common alert schema.
ActionGroupWebhookReceiverAadAuth, ActionGroupWebhookReceiverAadAuthArgs
, ActionGroupWebhookReceiverAadAuthArgs
- Object
Id This property is required. string - The webhook application object Id for AAD auth.
- Identifier
Uri string - The identifier URI for AAD auth.
- Tenant
Id string - The tenant id for AAD auth.
- Object
Id This property is required. string - The webhook application object Id for AAD auth.
- Identifier
Uri string - The identifier URI for AAD auth.
- Tenant
Id string - The tenant id for AAD auth.
- object
Id This property is required. String - The webhook application object Id for AAD auth.
- identifier
Uri String - The identifier URI for AAD auth.
- tenant
Id String - The tenant id for AAD auth.
- object
Id This property is required. string - The webhook application object Id for AAD auth.
- identifier
Uri string - The identifier URI for AAD auth.
- tenant
Id string - The tenant id for AAD auth.
- object_
id This property is required. str - The webhook application object Id for AAD auth.
- identifier_
uri str - The identifier URI for AAD auth.
- tenant_
id str - The tenant id for AAD auth.
- object
Id This property is required. String - The webhook application object Id for AAD auth.
- identifier
Uri String - The identifier URI for AAD auth.
- tenant
Id String - The tenant id for AAD auth.
Import
Action Groups can be imported using the resource id, e.g.
$ pulumi import azure:monitoring/actionGroup:ActionGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Insights/actionGroups/myagname
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.