Azure Native v3.2.0, Apr 14 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.monitor.getActionGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Using getActionGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getActionGroup(args: GetActionGroupArgs, opts?: InvokeOptions): Promise<GetActionGroupResult>
function getActionGroupOutput(args: GetActionGroupOutputArgs, opts?: InvokeOptions): Output<GetActionGroupResult>

def get_action_group(action_group_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetActionGroupResult
def get_action_group_output(action_group_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetActionGroupResult]

func LookupActionGroup(ctx *Context, args *LookupActionGroupArgs, opts ...InvokeOption) (*LookupActionGroupResult, error)
func LookupActionGroupOutput(ctx *Context, args *LookupActionGroupOutputArgs, opts ...InvokeOption) LookupActionGroupResultOutput

> Note: This function is named LookupActionGroup in the Go SDK.

public static class GetActionGroup 
{
    public static Task<GetActionGroupResult> InvokeAsync(GetActionGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetActionGroupResult> Invoke(GetActionGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetActionGroupResult> getActionGroup(GetActionGroupArgs args, InvokeOptions options)
public static Output<GetActionGroupResult> getActionGroup(GetActionGroupArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:monitor:getActionGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

ActionGroupName string: The name of the action group.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ActionGroupName string: The name of the action group.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

actionGroupName String: The name of the action group.
resourceGroupName String: The name of the resource group. The name is case insensitive.

actionGroupName string: The name of the action group.
resourceGroupName string: The name of the resource group. The name is case insensitive.

action_group_name str: The name of the action group.
resource_group_name str: The name of the resource group. The name is case insensitive.

actionGroupName String: The name of the action group.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getActionGroup Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Enabled bool: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
GroupShortName string: The short name of the action group. This will be used in SMS messages.
Id string: Azure resource Id
Location string: Resource location
Name string: Azure resource name
Type string: Azure resource type
ArmRoleReceivers List<Pulumi.AzureNative.Monitor.Outputs.ArmRoleReceiverResponse>: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
AutomationRunbookReceivers List<Pulumi.AzureNative.Monitor.Outputs.AutomationRunbookReceiverResponse>: The list of AutomationRunbook receivers that are part of this action group.
AzureAppPushReceivers List<Pulumi.AzureNative.Monitor.Outputs.AzureAppPushReceiverResponse>: The list of AzureAppPush receivers that are part of this action group.
AzureFunctionReceivers List<Pulumi.AzureNative.Monitor.Outputs.AzureFunctionReceiverResponse>: The list of azure function receivers that are part of this action group.
EmailReceivers List<Pulumi.AzureNative.Monitor.Outputs.EmailReceiverResponse>: The list of email receivers that are part of this action group.
EventHubReceivers List<Pulumi.AzureNative.Monitor.Outputs.EventHubReceiverResponse>: The list of event hub receivers that are part of this action group.
Identity Pulumi.AzureNative.Monitor.Outputs.ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
IncidentReceivers List<Pulumi.AzureNative.Monitor.Outputs.IncidentReceiverResponse>: The list of incident receivers that are part of this action group.
ItsmReceivers List<Pulumi.AzureNative.Monitor.Outputs.ItsmReceiverResponse>: The list of ITSM receivers that are part of this action group.
LogicAppReceivers List<Pulumi.AzureNative.Monitor.Outputs.LogicAppReceiverResponse>: The list of logic app receivers that are part of this action group.
SmsReceivers List<Pulumi.AzureNative.Monitor.Outputs.SmsReceiverResponse>: The list of SMS receivers that are part of this action group.
Tags Dictionary<string, string>: Resource tags
VoiceReceivers List<Pulumi.AzureNative.Monitor.Outputs.VoiceReceiverResponse>: The list of voice receivers that are part of this action group.
WebhookReceivers List<Pulumi.AzureNative.Monitor.Outputs.WebhookReceiverResponse>: The list of webhook receivers that are part of this action group.

AzureApiVersion string: The Azure API version of the resource.
Enabled bool: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
GroupShortName string: The short name of the action group. This will be used in SMS messages.
Id string: Azure resource Id
Location string: Resource location
Name string: Azure resource name
Type string: Azure resource type
ArmRoleReceivers []ArmRoleReceiverResponse: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
AutomationRunbookReceivers []AutomationRunbookReceiverResponse: The list of AutomationRunbook receivers that are part of this action group.
AzureAppPushReceivers []AzureAppPushReceiverResponse: The list of AzureAppPush receivers that are part of this action group.
AzureFunctionReceivers []AzureFunctionReceiverResponse: The list of azure function receivers that are part of this action group.
EmailReceivers []EmailReceiverResponse: The list of email receivers that are part of this action group.
EventHubReceivers []EventHubReceiverResponse: The list of event hub receivers that are part of this action group.
Identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
IncidentReceivers []IncidentReceiverResponse: The list of incident receivers that are part of this action group.
ItsmReceivers []ItsmReceiverResponse: The list of ITSM receivers that are part of this action group.
LogicAppReceivers []LogicAppReceiverResponse: The list of logic app receivers that are part of this action group.
SmsReceivers []SmsReceiverResponse: The list of SMS receivers that are part of this action group.
Tags map[string]string: Resource tags
VoiceReceivers []VoiceReceiverResponse: The list of voice receivers that are part of this action group.
WebhookReceivers []WebhookReceiverResponse: The list of webhook receivers that are part of this action group.

azureApiVersion String: The Azure API version of the resource.
enabled Boolean: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
groupShortName String: The short name of the action group. This will be used in SMS messages.
id String: Azure resource Id
location String: Resource location
name String: Azure resource name
type String: Azure resource type
armRoleReceivers List<ArmRoleReceiverResponse>: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automationRunbookReceivers List<AutomationRunbookReceiverResponse>: The list of AutomationRunbook receivers that are part of this action group.
azureAppPushReceivers List<AzureAppPushReceiverResponse>: The list of AzureAppPush receivers that are part of this action group.
azureFunctionReceivers List<AzureFunctionReceiverResponse>: The list of azure function receivers that are part of this action group.
emailReceivers List<EmailReceiverResponse>: The list of email receivers that are part of this action group.
eventHubReceivers List<EventHubReceiverResponse>: The list of event hub receivers that are part of this action group.
identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
incidentReceivers List<IncidentReceiverResponse>: The list of incident receivers that are part of this action group.
itsmReceivers List<ItsmReceiverResponse>: The list of ITSM receivers that are part of this action group.
logicAppReceivers List<LogicAppReceiverResponse>: The list of logic app receivers that are part of this action group.
smsReceivers List<SmsReceiverResponse>: The list of SMS receivers that are part of this action group.
tags Map<String,String>: Resource tags
voiceReceivers List<VoiceReceiverResponse>: The list of voice receivers that are part of this action group.
webhookReceivers List<WebhookReceiverResponse>: The list of webhook receivers that are part of this action group.

azureApiVersion string: The Azure API version of the resource.
enabled boolean: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
groupShortName string: The short name of the action group. This will be used in SMS messages.
id string: Azure resource Id
location string: Resource location
name string: Azure resource name
type string: Azure resource type
armRoleReceivers ArmRoleReceiverResponse[]: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automationRunbookReceivers AutomationRunbookReceiverResponse[]: The list of AutomationRunbook receivers that are part of this action group.
azureAppPushReceivers AzureAppPushReceiverResponse[]: The list of AzureAppPush receivers that are part of this action group.
azureFunctionReceivers AzureFunctionReceiverResponse[]: The list of azure function receivers that are part of this action group.
emailReceivers EmailReceiverResponse[]: The list of email receivers that are part of this action group.
eventHubReceivers EventHubReceiverResponse[]: The list of event hub receivers that are part of this action group.
identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
incidentReceivers IncidentReceiverResponse[]: The list of incident receivers that are part of this action group.
itsmReceivers ItsmReceiverResponse[]: The list of ITSM receivers that are part of this action group.
logicAppReceivers LogicAppReceiverResponse[]: The list of logic app receivers that are part of this action group.
smsReceivers SmsReceiverResponse[]: The list of SMS receivers that are part of this action group.
tags {[key: string]: string}: Resource tags
voiceReceivers VoiceReceiverResponse[]: The list of voice receivers that are part of this action group.
webhookReceivers WebhookReceiverResponse[]: The list of webhook receivers that are part of this action group.

azure_api_version str: The Azure API version of the resource.
enabled bool: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
group_short_name str: The short name of the action group. This will be used in SMS messages.
id str: Azure resource Id
location str: Resource location
name str: Azure resource name
type str: Azure resource type
arm_role_receivers Sequence[ArmRoleReceiverResponse]: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automation_runbook_receivers Sequence[AutomationRunbookReceiverResponse]: The list of AutomationRunbook receivers that are part of this action group.
azure_app_push_receivers Sequence[AzureAppPushReceiverResponse]: The list of AzureAppPush receivers that are part of this action group.
azure_function_receivers Sequence[AzureFunctionReceiverResponse]: The list of azure function receivers that are part of this action group.
email_receivers Sequence[EmailReceiverResponse]: The list of email receivers that are part of this action group.
event_hub_receivers Sequence[EventHubReceiverResponse]: The list of event hub receivers that are part of this action group.
identity ManagedServiceIdentityResponse: Managed service identity (system assigned and/or user assigned identities)
incident_receivers Sequence[IncidentReceiverResponse]: The list of incident receivers that are part of this action group.
itsm_receivers Sequence[ItsmReceiverResponse]: The list of ITSM receivers that are part of this action group.
logic_app_receivers Sequence[LogicAppReceiverResponse]: The list of logic app receivers that are part of this action group.
sms_receivers Sequence[SmsReceiverResponse]: The list of SMS receivers that are part of this action group.
tags Mapping[str, str]: Resource tags
voice_receivers Sequence[VoiceReceiverResponse]: The list of voice receivers that are part of this action group.
webhook_receivers Sequence[WebhookReceiverResponse]: The list of webhook receivers that are part of this action group.

azureApiVersion String: The Azure API version of the resource.
enabled Boolean: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
groupShortName String: The short name of the action group. This will be used in SMS messages.
id String: Azure resource Id
location String: Resource location
name String: Azure resource name
type String: Azure resource type
armRoleReceivers List<Property Map>: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
automationRunbookReceivers List<Property Map>: The list of AutomationRunbook receivers that are part of this action group.
azureAppPushReceivers List<Property Map>: The list of AzureAppPush receivers that are part of this action group.
azureFunctionReceivers List<Property Map>: The list of azure function receivers that are part of this action group.
emailReceivers List<Property Map>: The list of email receivers that are part of this action group.
eventHubReceivers List<Property Map>: The list of event hub receivers that are part of this action group.
identity Property Map: Managed service identity (system assigned and/or user assigned identities)
incidentReceivers List<Property Map>: The list of incident receivers that are part of this action group.
itsmReceivers List<Property Map>: The list of ITSM receivers that are part of this action group.
logicAppReceivers List<Property Map>: The list of logic app receivers that are part of this action group.
smsReceivers List<Property Map>: The list of SMS receivers that are part of this action group.
tags Map<String>: Resource tags
voiceReceivers List<Property Map>: The list of voice receivers that are part of this action group.
webhookReceivers List<Property Map>: The list of webhook receivers that are part of this action group.

Supporting Types

ArmRoleReceiverResponse

Name string: The name of the arm role receiver. Names must be unique across all receivers within an action group.
RoleId string: The arm role id.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

Name string: The name of the arm role receiver. Names must be unique across all receivers within an action group.
RoleId string: The arm role id.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

name String: The name of the arm role receiver. Names must be unique across all receivers within an action group.
roleId String: The arm role id.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

name string: The name of the arm role receiver. Names must be unique across all receivers within an action group.
roleId string: The arm role id.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

name str: The name of the arm role receiver. Names must be unique across all receivers within an action group.
role_id str: The arm role id.
use_common_alert_schema bool: Indicates whether to use common alert schema.

name String: The name of the arm role receiver. Names must be unique across all receivers within an action group.
roleId String: The arm role id.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

AutomationRunbookReceiverResponse

AutomationAccountId string: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
IsGlobalRunbook bool: Indicates whether this instance is global runbook.
RunbookName string: The name for this runbook.
WebhookResourceId string: The resource id for webhook linked to this runbook.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
Name string: Indicates name of the webhook.
ServiceUri string: The URI where webhooks should be sent.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

AutomationAccountId string: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
IsGlobalRunbook bool: Indicates whether this instance is global runbook.
RunbookName string: The name for this runbook.
WebhookResourceId string: The resource id for webhook linked to this runbook.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
Name string: Indicates name of the webhook.
ServiceUri string: The URI where webhooks should be sent.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

automationAccountId String: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
isGlobalRunbook Boolean: Indicates whether this instance is global runbook.
runbookName String: The name for this runbook.
webhookResourceId String: The resource id for webhook linked to this runbook.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
name String: Indicates name of the webhook.
serviceUri String: The URI where webhooks should be sent.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

automationAccountId string: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
isGlobalRunbook boolean: Indicates whether this instance is global runbook.
runbookName string: The name for this runbook.
webhookResourceId string: The resource id for webhook linked to this runbook.
managedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
name string: Indicates name of the webhook.
serviceUri string: The URI where webhooks should be sent.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

automation_account_id str: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
is_global_runbook bool: Indicates whether this instance is global runbook.
runbook_name str: The name for this runbook.
webhook_resource_id str: The resource id for webhook linked to this runbook.
managed_identity str: The principal id of the managed identity. The value can be "None", "SystemAssigned"
name str: Indicates name of the webhook.
service_uri str: The URI where webhooks should be sent.
use_common_alert_schema bool: Indicates whether to use common alert schema.

automationAccountId String: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
isGlobalRunbook Boolean: Indicates whether this instance is global runbook.
runbookName String: The name for this runbook.
webhookResourceId String: The resource id for webhook linked to this runbook.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
name String: Indicates name of the webhook.
serviceUri String: The URI where webhooks should be sent.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

AzureAppPushReceiverResponse

EmailAddress string: The email address registered for the Azure mobile app.
Name string: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

EmailAddress string: The email address registered for the Azure mobile app.
Name string: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

emailAddress String: The email address registered for the Azure mobile app.
name String: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

emailAddress string: The email address registered for the Azure mobile app.
name string: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

email_address str: The email address registered for the Azure mobile app.
name str: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

emailAddress String: The email address registered for the Azure mobile app.
name String: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

AzureFunctionReceiverResponse

FunctionAppResourceId string: The azure resource id of the function app.
FunctionName string: The function name in the function app.
HttpTriggerUrl string: The http trigger url where http request sent to.
Name string: The name of the azure function receiver. Names must be unique across all receivers within an action group.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

FunctionAppResourceId string: The azure resource id of the function app.
FunctionName string: The function name in the function app.
HttpTriggerUrl string: The http trigger url where http request sent to.
Name string: The name of the azure function receiver. Names must be unique across all receivers within an action group.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

functionAppResourceId String: The azure resource id of the function app.
functionName String: The function name in the function app.
httpTriggerUrl String: The http trigger url where http request sent to.
name String: The name of the azure function receiver. Names must be unique across all receivers within an action group.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

functionAppResourceId string: The azure resource id of the function app.
functionName string: The function name in the function app.
httpTriggerUrl string: The http trigger url where http request sent to.
name string: The name of the azure function receiver. Names must be unique across all receivers within an action group.
managedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

function_app_resource_id str: The azure resource id of the function app.
function_name str: The function name in the function app.
http_trigger_url str: The http trigger url where http request sent to.
name str: The name of the azure function receiver. Names must be unique across all receivers within an action group.
managed_identity str: The principal id of the managed identity. The value can be "None", "SystemAssigned"
use_common_alert_schema bool: Indicates whether to use common alert schema.

functionAppResourceId String: The azure resource id of the function app.
functionName String: The function name in the function app.
httpTriggerUrl String: The http trigger url where http request sent to.
name String: The name of the azure function receiver. Names must be unique across all receivers within an action group.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

EmailReceiverResponse

EmailAddress string: The email address of this receiver.
Name string: The name of the email receiver. Names must be unique across all receivers within a tenant action group.
Status string: The receiver status of the e-mail.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

EmailAddress string: The email address of this receiver.
Name string: The name of the email receiver. Names must be unique across all receivers within a tenant action group.
Status string: The receiver status of the e-mail.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

emailAddress String: The email address of this receiver.
name String: The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status String: The receiver status of the e-mail.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

emailAddress string: The email address of this receiver.
name string: The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status string: The receiver status of the e-mail.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

email_address str: The email address of this receiver.
name str: The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status str: The receiver status of the e-mail.
use_common_alert_schema bool: Indicates whether to use common alert schema.

emailAddress String: The email address of this receiver.
name String: The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status String: The receiver status of the e-mail.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

EventHubReceiverResponse

EventHubName string: The name of the specific Event Hub queue
EventHubNameSpace string: The Event Hub namespace
Name string: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
SubscriptionId string: The Id for the subscription containing this event hub
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
TenantId string: The tenant Id for the subscription containing this event hub
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

EventHubName string: The name of the specific Event Hub queue
EventHubNameSpace string: The Event Hub namespace
Name string: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
SubscriptionId string: The Id for the subscription containing this event hub
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
TenantId string: The tenant Id for the subscription containing this event hub
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

eventHubName String: The name of the specific Event Hub queue
eventHubNameSpace String: The Event Hub namespace
name String: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
subscriptionId String: The Id for the subscription containing this event hub
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
tenantId String: The tenant Id for the subscription containing this event hub
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

eventHubName string: The name of the specific Event Hub queue
eventHubNameSpace string: The Event Hub namespace
name string: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
subscriptionId string: The Id for the subscription containing this event hub
managedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
tenantId string: The tenant Id for the subscription containing this event hub
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

event_hub_name str: The name of the specific Event Hub queue
event_hub_name_space str: The Event Hub namespace
name str: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
subscription_id str: The Id for the subscription containing this event hub
managed_identity str: The principal id of the managed identity. The value can be "None", "SystemAssigned"
tenant_id str: The tenant Id for the subscription containing this event hub
use_common_alert_schema bool: Indicates whether to use common alert schema.

eventHubName String: The name of the specific Event Hub queue
eventHubNameSpace String: The Event Hub namespace
name String: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
subscriptionId String: The Id for the subscription containing this event hub
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
tenantId String: The tenant Id for the subscription containing this event hub
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

IncidentReceiverResponse

Connection Pulumi.AzureNative.Monitor.Inputs.IncidentServiceConnectionResponse: The incident service connection
IncidentManagementService string: The incident management service type
Mappings Dictionary<string, string>: Field mappings for the incident service
Name string: The name of the Incident receiver. Names must be unique across all receivers within an action group.

Connection IncidentServiceConnectionResponse: The incident service connection
IncidentManagementService string: The incident management service type
Mappings map[string]string: Field mappings for the incident service
Name string: The name of the Incident receiver. Names must be unique across all receivers within an action group.

connection IncidentServiceConnectionResponse: The incident service connection
incidentManagementService String: The incident management service type
mappings Map<String,String>: Field mappings for the incident service
name String: The name of the Incident receiver. Names must be unique across all receivers within an action group.

connection IncidentServiceConnectionResponse: The incident service connection
incidentManagementService string: The incident management service type
mappings {[key: string]: string}: Field mappings for the incident service
name string: The name of the Incident receiver. Names must be unique across all receivers within an action group.

connection IncidentServiceConnectionResponse: The incident service connection
incident_management_service str: The incident management service type
mappings Mapping[str, str]: Field mappings for the incident service
name str: The name of the Incident receiver. Names must be unique across all receivers within an action group.

connection Property Map: The incident service connection
incidentManagementService String: The incident management service type
mappings Map<String>: Field mappings for the incident service
name String: The name of the Incident receiver. Names must be unique across all receivers within an action group.

IncidentServiceConnectionResponse

Id string: GUID value representing the connection ID for the incident management service.
Name string: The name of the connection.

Id string: GUID value representing the connection ID for the incident management service.
Name string: The name of the connection.

id String: GUID value representing the connection ID for the incident management service.
name String: The name of the connection.

id string: GUID value representing the connection ID for the incident management service.
name string: The name of the connection.

id str: GUID value representing the connection ID for the incident management service.
name str: The name of the connection.

id String: GUID value representing the connection ID for the incident management service.
name String: The name of the connection.

ItsmReceiverResponse

ConnectionId string: Unique identification of ITSM connection among multiple defined in above workspace.
Name string: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
Region string: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
TicketConfiguration string: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
WorkspaceId string: OMS LA instance identifier.

ConnectionId string: Unique identification of ITSM connection among multiple defined in above workspace.
Name string: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
Region string: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
TicketConfiguration string: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
WorkspaceId string: OMS LA instance identifier.

connectionId String: Unique identification of ITSM connection among multiple defined in above workspace.
name String: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
region String: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration String: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
workspaceId String: OMS LA instance identifier.

connectionId string: Unique identification of ITSM connection among multiple defined in above workspace.
name string: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
region string: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration string: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
workspaceId string: OMS LA instance identifier.

connection_id str: Unique identification of ITSM connection among multiple defined in above workspace.
name str: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
region str: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticket_configuration str: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
workspace_id str: OMS LA instance identifier.

connectionId String: Unique identification of ITSM connection among multiple defined in above workspace.
name String: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
region String: Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'
ticketConfiguration String: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
workspaceId String: OMS LA instance identifier.

LogicAppReceiverResponse

CallbackUrl string: The callback url where http request sent to.
Name string: The name of the logic app receiver. Names must be unique across all receivers within an action group.
ResourceId string: The azure resource id of the logic app receiver.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

CallbackUrl string: The callback url where http request sent to.
Name string: The name of the logic app receiver. Names must be unique across all receivers within an action group.
ResourceId string: The azure resource id of the logic app receiver.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

callbackUrl String: The callback url where http request sent to.
name String: The name of the logic app receiver. Names must be unique across all receivers within an action group.
resourceId String: The azure resource id of the logic app receiver.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

callbackUrl string: The callback url where http request sent to.
name string: The name of the logic app receiver. Names must be unique across all receivers within an action group.
resourceId string: The azure resource id of the logic app receiver.
managedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

callback_url str: The callback url where http request sent to.
name str: The name of the logic app receiver. Names must be unique across all receivers within an action group.
resource_id str: The azure resource id of the logic app receiver.
managed_identity str: The principal id of the managed identity. The value can be "None", "SystemAssigned"
use_common_alert_schema bool: Indicates whether to use common alert schema.

callbackUrl String: The callback url where http request sent to.
name String: The name of the logic app receiver. Names must be unique across all receivers within an action group.
resourceId String: The azure resource id of the logic app receiver.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

ManagedServiceIdentityResponse

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Monitor.Inputs.UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principal_id str: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id str: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type str: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

SmsReceiverResponse

CountryCode string: The country code of the SMS receiver.
Name string: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber string: The phone number of the SMS receiver.
Status string: The status of the receiver.

CountryCode string: The country code of the SMS receiver.
Name string: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber string: The phone number of the SMS receiver.
Status string: The status of the receiver.

countryCode String: The country code of the SMS receiver.
name String: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber String: The phone number of the SMS receiver.
status String: The status of the receiver.

countryCode string: The country code of the SMS receiver.
name string: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber string: The phone number of the SMS receiver.
status string: The status of the receiver.

country_code str: The country code of the SMS receiver.
name str: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phone_number str: The phone number of the SMS receiver.
status str: The status of the receiver.

countryCode String: The country code of the SMS receiver.
name String: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber String: The phone number of the SMS receiver.
status String: The status of the receiver.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

VoiceReceiverResponse

CountryCode string: The country code of the voice receiver.
Name string: The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber string: The phone number of the voice receiver.

CountryCode string: The country code of the voice receiver.
Name string: The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber string: The phone number of the voice receiver.

countryCode String: The country code of the voice receiver.
name String: The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber String: The phone number of the voice receiver.

countryCode string: The country code of the voice receiver.
name string: The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber 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. Names must be unique across all receivers within a tenant action group.
phone_number str: The phone number of the voice receiver.

countryCode String: The country code of the voice receiver.
name String: The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber String: The phone number of the voice receiver.

WebhookReceiverResponse

Name string: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
ServiceUri string: The URI where webhooks should be sent.
IdentifierUri string: Indicates the identifier uri for aad auth.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
ObjectId string: Indicates the webhook app object Id for aad auth.
TenantId string: Indicates the tenant id for aad auth.
UseAadAuth bool: Indicates whether or not use AAD authentication.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

Name string: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
ServiceUri string: The URI where webhooks should be sent.
IdentifierUri string: Indicates the identifier uri for aad auth.
ManagedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
ObjectId string: Indicates the webhook app object Id for aad auth.
TenantId string: Indicates the tenant id for aad auth.
UseAadAuth bool: Indicates whether or not use AAD authentication.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

name String: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
serviceUri String: The URI where webhooks should be sent.
identifierUri String: Indicates the identifier uri for aad auth.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
objectId String: Indicates the webhook app object Id for aad auth.
tenantId String: Indicates the tenant id for aad auth.
useAadAuth Boolean: Indicates whether or not use AAD authentication.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

name string: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
serviceUri string: The URI where webhooks should be sent.
identifierUri string: Indicates the identifier uri for aad auth.
managedIdentity string: The principal id of the managed identity. The value can be "None", "SystemAssigned"
objectId string: Indicates the webhook app object Id for aad auth.
tenantId string: Indicates the tenant id for aad auth.
useAadAuth boolean: Indicates whether or not use AAD authentication.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

name str: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
service_uri str: The URI where webhooks should be sent.
identifier_uri str: Indicates the identifier uri for aad auth.
managed_identity str: The principal id of the managed identity. The value can be "None", "SystemAssigned"
object_id str: Indicates the webhook app object Id for aad auth.
tenant_id str: Indicates the tenant id for aad auth.
use_aad_auth bool: Indicates whether or not use AAD authentication.
use_common_alert_schema bool: Indicates whether to use common alert schema.

name String: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
serviceUri String: The URI where webhooks should be sent.
identifierUri String: Indicates the identifier uri for aad auth.
managedIdentity String: The principal id of the managed identity. The value can be "None", "SystemAssigned"
objectId String: Indicates the webhook app object Id for aad auth.
tenantId String: Indicates the tenant id for aad auth.
useAadAuth Boolean: Indicates whether or not use AAD authentication.
useCommonAlertSchema Boolean: Indicates whether to use common alert schema.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.monitor.getActionGroup

On this page

On this page

Using getActionGroup

getActionGroup Result

Supporting Types

ArmRoleReceiverResponse

AutomationRunbookReceiverResponse

AzureAppPushReceiverResponse

AzureFunctionReceiverResponse

EmailReceiverResponse

EventHubReceiverResponse

IncidentReceiverResponse

IncidentServiceConnectionResponse

ItsmReceiverResponse

LogicAppReceiverResponse

ManagedServiceIdentityResponse

SmsReceiverResponse

UserAssignedIdentityResponse

VoiceReceiverResponse

WebhookReceiverResponse

Package Details

On this page

On this page