ActionGroup
Manages an Action Group within Azure Monitor.
Create a ActionGroup Resource
new ActionGroup(name: string, args: ActionGroupArgs, opts?: CustomResourceOptions);def ActionGroup(resource_name, opts=None, arm_role_receivers=None, automation_runbook_receivers=None, azure_app_push_receivers=None, azure_function_receivers=None, email_receivers=None, enabled=None, itsm_receivers=None, logic_app_receivers=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, tags=None, voice_receivers=None, webhook_receivers=None, __props__=None);func NewActionGroup(ctx *Context, name string, args ActionGroupArgs, opts ...ResourceOption) (*ActionGroup, error)public ActionGroup(string name, ActionGroupArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args ActionGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ActionGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActionGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
ActionGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The ActionGroup resource accepts the following input properties:
- Resource
Group stringName The name of the resource group in which to create the Action Group instance.
- Short
Name string The short name of the action group. This will be used in SMS messages.
- Arm
Role List<ActionReceivers Group Arm Role Receiver Args> One or more
arm_role_receiverblocks as defined below.- Automation
Runbook List<ActionReceivers Group Automation Runbook Receiver Args> One or more
automation_runbook_receiverblocks as defined below.- Azure
App List<ActionPush Receivers Group Azure App Push Receiver Args> One or more
azure_app_push_receiverblocks as defined below.- Azure
Function List<ActionReceivers Group Azure Function Receiver Args> One or more
azure_function_receiverblocks as defined below.- Email
Receivers List<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.- Itsm
Receivers List<ActionGroup Itsm Receiver Args> One or more
itsm_receiverblocks as defined below.- Logic
App List<ActionReceivers Group Logic App Receiver Args> One or more
logic_app_receiverblocks as defined below.- Name string
The name of the Action Group. Changing this forces a new resource to be created.
- Sms
Receivers List<ActionGroup Sms Receiver Args> 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 Args> One or more
voice_receiverblocks as defined below.- Webhook
Receivers List<ActionGroup Webhook Receiver Args> One or more
webhook_receiverblocks as defined below.
- Resource
Group stringName The name of the resource group in which to create the Action Group instance.
- Short
Name 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 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.- Itsm
Receivers []ActionGroup Itsm Receiver One or more
itsm_receiverblocks as defined below.- Logic
App []ActionReceivers Group Logic App Receiver One or more
logic_app_receiverblocks as defined below.- Name string
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.- map[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 stringName The name of the resource group in which to create the Action Group instance.
- short
Name 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.- itsm
Receivers ActionGroup Itsm Receiver[] One or more
itsm_receiverblocks as defined below.- logic
App ActionReceivers Group Logic App Receiver[] One or more
logic_app_receiverblocks as defined below.- name string
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_ strname The name of the resource group in which to create the Action Group instance.
- short_
name str 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.- itsm_
receivers List[ActionGroup Itsm Receiver] One or more
itsm_receiverblocks as defined below.- logic_
app_ List[Actionreceivers Group Logic App Receiver] One or more
logic_app_receiverblocks as defined below.- name str
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.- Dict[str, str]
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.
Outputs
All input properties are implicitly available as output properties. Additionally, the ActionGroup resource produces the following output properties:
Look up an 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): ActionGroupstatic get(resource_name, id, opts=None, arm_role_receivers=None, automation_runbook_receivers=None, azure_app_push_receivers=None, azure_function_receivers=None, email_receivers=None, enabled=None, itsm_receivers=None, logic_app_receivers=None, name=None, resource_group_name=None, short_name=None, sms_receivers=None, tags=None, voice_receivers=None, webhook_receivers=None, __props__=None);func 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)- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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 Args> One or more
arm_role_receiverblocks as defined below.- Automation
Runbook List<ActionReceivers Group Automation Runbook Receiver Args> One or more
automation_runbook_receiverblocks as defined below.- Azure
App List<ActionPush Receivers Group Azure App Push Receiver Args> One or more
azure_app_push_receiverblocks as defined below.- Azure
Function List<ActionReceivers Group Azure Function Receiver Args> One or more
azure_function_receiverblocks as defined below.- Email
Receivers List<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.- Itsm
Receivers List<ActionGroup Itsm Receiver Args> One or more
itsm_receiverblocks as defined below.- Logic
App List<ActionReceivers Group Logic App Receiver Args> One or more
logic_app_receiverblocks as defined below.- Name string
The name of the Action Group. Changing this forces a new resource to be created.
- Resource
Group stringName The name of the resource group in which to create the Action Group instance.
- Short
Name string The short name of the action group. This will be used in SMS messages.
- Sms
Receivers List<ActionGroup Sms Receiver Args> 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 Args> One or more
voice_receiverblocks as defined below.- Webhook
Receivers List<ActionGroup Webhook Receiver Args> 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 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.- Itsm
Receivers []ActionGroup Itsm Receiver One or more
itsm_receiverblocks as defined below.- Logic
App []ActionReceivers Group Logic App Receiver One or more
logic_app_receiverblocks as defined below.- Name string
The name of the Action Group. Changing this forces a new resource to be created.
- Resource
Group stringName The name of the resource group in which to create the Action Group instance.
- 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.- map[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 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.- itsm
Receivers ActionGroup Itsm Receiver[] One or more
itsm_receiverblocks as defined below.- logic
App ActionReceivers Group Logic App Receiver[] One or more
logic_app_receiverblocks as defined below.- name string
The name of the Action Group. Changing this forces a new resource to be created.
- resource
Group stringName The name of the resource group in which to create the Action Group instance.
- 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_ 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.- itsm_
receivers List[ActionGroup Itsm Receiver] One or more
itsm_receiverblocks as defined below.- logic_
app_ List[Actionreceivers Group Logic App Receiver] One or more
logic_app_receiverblocks as defined below.- name str
The name of the Action Group. Changing this forces a new resource to be created.
- resource_
group_ strname The name of the resource group in which to create the Action Group instance.
- short_
name str 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.- Dict[str, str]
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.
Supporting Types
ActionGroupArmRoleReceiver
ActionGroupAutomationRunbookReceiver
- Automation
Account stringId The automation account ID which holds this runbook and authenticates to Azure resources.
- Is
Global boolRunbook Indicates whether this instance is global runbook.
- Name string
The name of the automation runbook receiver.
- Runbook
Name string The name for this runbook.
- Service
Uri string The URI where webhooks should be sent.
- Webhook
Resource stringId The resource id for webhook linked to this runbook.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- Automation
Account stringId The automation account ID which holds this runbook and authenticates to Azure resources.
- Is
Global boolRunbook Indicates whether this instance is global runbook.
- Name string
The name of the automation runbook receiver.
- Runbook
Name string The name for this runbook.
- Service
Uri string The URI where webhooks should be sent.
- Webhook
Resource stringId The resource id for webhook linked to this runbook.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- automation
Account stringId The automation account ID which holds this runbook and authenticates to Azure resources.
- is
Global booleanRunbook Indicates whether this instance is global runbook.
- name string
The name of the automation runbook receiver.
- runbook
Name string The name for this runbook.
- service
Uri string The URI where webhooks should be sent.
- webhook
Resource stringId The resource id for webhook linked to this runbook.
- use
Common booleanAlert Schema Enables or disables the common alert schema.
- automation
Account strId The automation account ID which holds this runbook and authenticates to Azure resources.
- is
Global boolRunbook Indicates whether this instance is global runbook.
- name str
The name of the automation runbook receiver.
- runbook_
name str The name for this runbook.
- service_
uri str The URI where webhooks should be sent.
- webhook
Resource strId The resource id for webhook linked to this runbook.
- use
Common boolAlert Schema Enables or disables the common alert schema.
ActionGroupAzureAppPushReceiver
- Email
Address string The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- Name string
The name of the Azure app push receiver.
- Email
Address string The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- Name string
The name of the Azure app push receiver.
- email
Address string The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- name string
The name of the Azure app push receiver.
- email_
address str The email address of the user signed into the mobile app who will receive push notifications from this receiver.
- name str
The name of the Azure app push receiver.
ActionGroupAzureFunctionReceiver
- Function
App stringResource Id The Azure resource ID of the function app.
- Function
Name string The function name in the function app.
- Http
Trigger stringUrl The http trigger url where http request sent to.
- Name string
The name of the Azure Function receiver.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- Function
App stringResource Id The Azure resource ID of the function app.
- Function
Name string The function name in the function app.
- Http
Trigger stringUrl The http trigger url where http request sent to.
- Name string
The name of the Azure Function receiver.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- function
App stringResource Id The Azure resource ID of the function app.
- function
Name string The function name in the function app.
- http
Trigger stringUrl The http trigger url where http request sent to.
- name string
The name of the Azure Function receiver.
- use
Common booleanAlert Schema Enables or disables the common alert schema.
- function
App strResource Id The Azure resource ID of the function app.
- function
Name str The function name in the function app.
- http
Trigger strUrl The http trigger url where http request sent to.
- name str
The name of the Azure Function receiver.
- use
Common boolAlert Schema Enables or disables the common alert schema.
ActionGroupEmailReceiver
- Email
Address string The email address of this receiver.
- Name 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 string The email address of this receiver.
- Name 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 string The email address of this receiver.
- name 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 str The email address of this receiver.
- name 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.
ActionGroupItsmReceiver
- Connection
Id string The unique connection identifier of the ITSM connection.
- Name string
The name of the ITSM receiver.
- Region string
The region of the workspace.
- Ticket
Configuration string A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- Workspace
Id string The Azure Log Analytics workspace ID where this connection is defined.
- Connection
Id string The unique connection identifier of the ITSM connection.
- Name string
The name of the ITSM receiver.
- Region string
The region of the workspace.
- Ticket
Configuration string A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- Workspace
Id string The Azure Log Analytics workspace ID where this connection is defined.
- connection
Id string The unique connection identifier of the ITSM connection.
- name string
The name of the ITSM receiver.
- region string
The region of the workspace.
- ticket
Configuration string A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- workspace
Id string The Azure Log Analytics workspace ID where this connection is defined.
- connection
Id str The unique connection identifier of the ITSM connection.
- name str
The name of the ITSM receiver.
- region str
The region of the workspace.
- ticket
Configuration str A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
- workspace_
id str The Azure Log Analytics workspace ID where this connection is defined.
ActionGroupLogicAppReceiver
- Callback
Url string The callback url where http request sent to.
- Name string
The name of the logic app receiver.
- Resource
Id string The Azure resource ID of the logic app.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- Callback
Url string The callback url where http request sent to.
- Name string
The name of the logic app receiver.
- Resource
Id string The Azure resource ID of the logic app.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- callback
Url string The callback url where http request sent to.
- name string
The name of the logic app receiver.
- resource
Id string The Azure resource ID of the logic app.
- use
Common booleanAlert Schema Enables or disables the common alert schema.
- callback
Url str The callback url where http request sent to.
- name str
The name of the logic app receiver.
- resource_
id str The Azure resource ID of the logic app.
- use
Common boolAlert Schema Enables or disables the common alert schema.
ActionGroupSmsReceiver
- Country
Code string The country code of the SMS receiver.
- Name string
The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Phone
Number string The phone number of the SMS receiver.
- Country
Code string The country code of the SMS receiver.
- Name string
The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Phone
Number string The phone number of the SMS receiver.
- country
Code string The country code of the SMS receiver.
- name string
The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- phone
Number string The phone number of the SMS receiver.
- country
Code str The country code of the SMS receiver.
- name str
The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- phone
Number str The phone number of the SMS receiver.
ActionGroupVoiceReceiver
- Country
Code string The country code of the voice receiver.
- Name string
The name of the voice receiver.
- Phone
Number string The phone number of the voice receiver.
- Country
Code string The country code of the voice receiver.
- Name string
The name of the voice receiver.
- Phone
Number string The phone number of the voice receiver.
- country
Code string The country code of the voice receiver.
- name string
The name of the voice receiver.
- phone
Number string The phone number of the voice receiver.
- country
Code str The country code of the voice receiver.
- name str
The name of the voice receiver.
- phone
Number str The phone number of the voice receiver.
ActionGroupWebhookReceiver
- Name string
The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Service
Uri string The URI where webhooks should be sent.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- Name string
The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- Service
Uri string The URI where webhooks should be sent.
- Use
Common boolAlert Schema Enables or disables the common alert schema.
- name string
The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- service
Uri string The URI where webhooks should be sent.
- use
Common booleanAlert Schema Enables or disables the common alert schema.
- name str
The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.
- service_
uri str The URI where webhooks should be sent.
- use
Common boolAlert Schema Enables or disables the common alert schema.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.