GetActionGroup

Use this data source to access the properties of an Action Group.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Monitoring.GetActionGroup.InvokeAsync(new Azure.Monitoring.GetActionGroupArgs
        {
            ResourceGroupName = "example-rg",
            Name = "tfex-actiongroup",
        }));
        this.ActionGroupId = example.Apply(example => example.Id);
    }

    [Output("actionGroupId")]
    public Output<string> ActionGroupId { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/monitoring"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := monitoring.LookupActionGroup(ctx, &monitoring.LookupActionGroupArgs{
            ResourceGroupName: "example-rg",
            Name:              "tfex-actiongroup",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("actionGroupId", example.Id)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.monitoring.get_action_group(resource_group_name="example-rg",
    name="tfex-actiongroup")
pulumi.export("actionGroupId", example.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.monitoring.getActionGroup({
    resourceGroupName: "example-rg",
    name: "tfex-actiongroup",
});
export const actionGroupId = example.then(example => example.id);

Using GetActionGroup

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

function  get_action_group(name=None, resource_group_name=None, opts=None)

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

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

The following arguments are supported:

Name string: Specifies the name of the Action Group.
ResourceGroupName string: Specifies the name of the resource group the Action Group is located in.

Name string: Specifies the name of the Action Group.
ResourceGroupName string: Specifies the name of the resource group the Action Group is located in.

name string: Specifies the name of the Action Group.
resourceGroupName string: Specifies the name of the resource group the Action Group is located in.

name str: Specifies the name of the Action Group.
resource_group_name str: Specifies the name of the resource group the Action Group is located in.

GetActionGroup Result

The following output properties are available:

ArmRoleReceivers List<GetActionGroupArmRoleReceiver>: One or more arm_role_receiver blocks as defined below.
AutomationRunbookReceivers List<GetActionGroupAutomationRunbookReceiver>: One or more automation_runbook_receiver blocks as defined below.
AzureAppPushReceivers List<GetActionGroupAzureAppPushReceiver>: One or more azure_app_push_receiver blocks as defined below.
AzureFunctionReceivers List<GetActionGroupAzureFunctionReceiver>: One or more azure_function_receiver blocks as defined below.
EmailReceivers List<GetActionGroupEmailReceiver>: One or more email_receiver blocks as defined below.
Enabled bool: Whether this action group is enabled.
Id string: The provider-assigned unique ID for this managed resource.
ItsmReceivers List<GetActionGroupItsmReceiver>: One or more itsm_receiver blocks as defined below.
LogicAppReceivers List<GetActionGroupLogicAppReceiver>: One or more logic_app_receiver blocks as defined below.
Name string: The name of the webhook receiver.
ResourceGroupName string
ShortName string: The short name of the action group.
SmsReceivers List<GetActionGroupSmsReceiver>: One or more sms_receiver blocks as defined below.
VoiceReceivers List<GetActionGroupVoiceReceiver>: One or more voice_receiver blocks as defined below.
WebhookReceivers List<GetActionGroupWebhookReceiver>: One or more webhook_receiver blocks as defined below.

ArmRoleReceivers []GetActionGroupArmRoleReceiver: One or more arm_role_receiver blocks as defined below.
AutomationRunbookReceivers []GetActionGroupAutomationRunbookReceiver: One or more automation_runbook_receiver blocks as defined below.
AzureAppPushReceivers []GetActionGroupAzureAppPushReceiver: One or more azure_app_push_receiver blocks as defined below.
AzureFunctionReceivers []GetActionGroupAzureFunctionReceiver: One or more azure_function_receiver blocks as defined below.
EmailReceivers []GetActionGroupEmailReceiver: One or more email_receiver blocks as defined below.
Enabled bool: Whether this action group is enabled.
Id string: The provider-assigned unique ID for this managed resource.
ItsmReceivers []GetActionGroupItsmReceiver: One or more itsm_receiver blocks as defined below.
LogicAppReceivers []GetActionGroupLogicAppReceiver: One or more logic_app_receiver blocks as defined below.
Name string: The name of the webhook receiver.
ResourceGroupName string
ShortName string: The short name of the action group.
SmsReceivers []GetActionGroupSmsReceiver: One or more sms_receiver blocks as defined below.
VoiceReceivers []GetActionGroupVoiceReceiver: One or more voice_receiver blocks as defined below.
WebhookReceivers []GetActionGroupWebhookReceiver: One or more webhook_receiver blocks as defined below.

armRoleReceivers GetActionGroupArmRoleReceiver[]: One or more arm_role_receiver blocks as defined below.
automationRunbookReceivers GetActionGroupAutomationRunbookReceiver[]: One or more automation_runbook_receiver blocks as defined below.
azureAppPushReceivers GetActionGroupAzureAppPushReceiver[]: One or more azure_app_push_receiver blocks as defined below.
azureFunctionReceivers GetActionGroupAzureFunctionReceiver[]: One or more azure_function_receiver blocks as defined below.
emailReceivers GetActionGroupEmailReceiver[]: One or more email_receiver blocks as defined below.
enabled boolean: Whether this action group is enabled.
id string: The provider-assigned unique ID for this managed resource.
itsmReceivers GetActionGroupItsmReceiver[]: One or more itsm_receiver blocks as defined below.
logicAppReceivers GetActionGroupLogicAppReceiver[]: One or more logic_app_receiver blocks as defined below.
name string: The name of the webhook receiver.
resourceGroupName string
shortName string: The short name of the action group.
smsReceivers GetActionGroupSmsReceiver[]: One or more sms_receiver blocks as defined below.
voiceReceivers GetActionGroupVoiceReceiver[]: One or more voice_receiver blocks as defined below.
webhookReceivers GetActionGroupWebhookReceiver[]: One or more webhook_receiver blocks as defined below.

arm_role_receivers List[GetActionGroupArmRoleReceiver]: One or more arm_role_receiver blocks as defined below.
automation_runbook_receivers List[GetActionGroupAutomationRunbookReceiver]: One or more automation_runbook_receiver blocks as defined below.
azure_app_push_receivers List[GetActionGroupAzureAppPushReceiver]: One or more azure_app_push_receiver blocks as defined below.
azure_function_receivers List[GetActionGroupAzureFunctionReceiver]: One or more azure_function_receiver blocks as defined below.
email_receivers List[GetActionGroupEmailReceiver]: One or more email_receiver blocks as defined below.
enabled bool: Whether this action group is enabled.
id str: The provider-assigned unique ID for this managed resource.
itsm_receivers List[GetActionGroupItsmReceiver]: One or more itsm_receiver blocks as defined below.
logic_app_receivers List[GetActionGroupLogicAppReceiver]: One or more logic_app_receiver blocks as defined below.
name str: The name of the webhook receiver.
resource_group_name str
short_name str: The short name of the action group.
sms_receivers List[GetActionGroupSmsReceiver]: One or more sms_receiver blocks as defined below.
voice_receivers List[GetActionGroupVoiceReceiver]: One or more voice_receiver blocks as defined below.
webhook_receivers List[GetActionGroupWebhookReceiver]: One or more webhook_receiver blocks as defined below.

Supporting Types

GetActionGroupArmRoleReceiver

Name string: Specifies the name of the Action Group.
RoleId string: The arm role id.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

Name string: Specifies the name of the Action Group.
RoleId string: The arm role id.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

name string: Specifies the name of the Action Group.
roleId string: The arm role id.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

name str: Specifies the name of the Action Group.
roleId str: The arm role id.
useCommonAlertSchema bool: Indicates whether to use common alert schema.

GetActionGroupAutomationRunbookReceiver

AutomationAccountId string: The automation account ID which holds this runbook and authenticates to Azure resources.
IsGlobalRunbook bool: Indicates whether this instance is global runbook.
Name string: Specifies the name of the Action Group.
RunbookName string: The name for this runbook.
ServiceUri string: The URI where webhooks should be sent.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.
WebhookResourceId string: The resource id for webhook linked to this runbook.

AutomationAccountId string: The automation account ID which holds this runbook and authenticates to Azure resources.
IsGlobalRunbook bool: Indicates whether this instance is global runbook.
Name string: Specifies the name of the Action Group.
RunbookName string: The name for this runbook.
ServiceUri string: The URI where webhooks should be sent.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.
WebhookResourceId string: The resource id for webhook linked to this runbook.

automationAccountId string: The automation account ID which holds this runbook and authenticates to Azure resources.
isGlobalRunbook boolean: Indicates whether this instance is global runbook.
name string: Specifies the name of the Action Group.
runbookName string: The name for this runbook.
serviceUri string: The URI where webhooks should be sent.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.
webhookResourceId string: The resource id for webhook linked to this runbook.

automationAccountId str: The automation account ID which holds this runbook and authenticates to Azure resources.
isGlobalRunbook bool: Indicates whether this instance is global runbook.
name str: Specifies the name of the Action Group.
runbook_name str: The name for this runbook.
service_uri str: The URI where webhooks should be sent.
useCommonAlertSchema bool: Indicates whether to use common alert schema.
webhookResourceId str: The resource id for webhook linked to this runbook.

GetActionGroupAzureAppPushReceiver

EmailAddress string: The email address of this receiver.
Name string: Specifies the name of the Action Group.

EmailAddress string: The email address of this receiver.
Name string: Specifies the name of the Action Group.

emailAddress string: The email address of this receiver.
name string: Specifies the name of the Action Group.

email_address str: The email address of this receiver.
name str: Specifies the name of the Action Group.

GetActionGroupAzureFunctionReceiver

FunctionAppResourceId string
FunctionName string: The function name in the function app.
HttpTriggerUrl string: The http trigger url where http request sent to.
Name string: Specifies the name of the Action Group.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

FunctionAppResourceId string
FunctionName string: The function name in the function app.
HttpTriggerUrl string: The http trigger url where http request sent to.
Name string: Specifies the name of the Action Group.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

functionAppResourceId string
functionName string: The function name in the function app.
httpTriggerUrl string: The http trigger url where http request sent to.
name string: Specifies the name of the Action Group.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

functionAppResourceId str
functionName str: The function name in the function app.
httpTriggerUrl str: The http trigger url where http request sent to.
name str: Specifies the name of the Action Group.
useCommonAlertSchema bool: Indicates whether to use common alert schema.

GetActionGroupEmailReceiver

EmailAddress string: The email address of this receiver.
Name string: Specifies the name of the Action Group.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

EmailAddress string: The email address of this receiver.
Name string: Specifies the name of the Action Group.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

emailAddress string: The email address of this receiver.
name string: Specifies the name of the Action Group.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

email_address str: The email address of this receiver.
name str: Specifies the name of the Action Group.
useCommonAlertSchema bool: Indicates whether to use common alert schema.

GetActionGroupItsmReceiver

ConnectionId string: The unique connection identifier of the ITSM connection.
Name string: Specifies the name of the Action Group.
Region string: The region of the workspace.
TicketConfiguration string: A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
WorkspaceId string: The Azure Log Analytics workspace ID where this connection is defined.

ConnectionId string: The unique connection identifier of the ITSM connection.
Name string: Specifies the name of the Action Group.
Region string: The region of the workspace.
TicketConfiguration string: A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
WorkspaceId string: The Azure Log Analytics workspace ID where this connection is defined.

connectionId string: The unique connection identifier of the ITSM connection.
name string: Specifies the name of the Action Group.
region string: The region of the workspace.
ticketConfiguration string: A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
workspaceId string: The Azure Log Analytics workspace ID where this connection is defined.

connectionId str: The unique connection identifier of the ITSM connection.
name str: Specifies the name of the Action Group.
region str: The region of the workspace.
ticketConfiguration 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.

GetActionGroupLogicAppReceiver

CallbackUrl string: The callback url where http request sent to.
Name string: Specifies the name of the Action Group.
ResourceId string: The Azure resource ID of the logic app.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

CallbackUrl string: The callback url where http request sent to.
Name string: Specifies the name of the Action Group.
ResourceId string: The Azure resource ID of the logic app.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

callbackUrl string: The callback url where http request sent to.
name string: Specifies the name of the Action Group.
resourceId string: The Azure resource ID of the logic app.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

callbackUrl str: The callback url where http request sent to.
name str: Specifies the name of the Action Group.
resource_id str: The Azure resource ID of the logic app.
useCommonAlertSchema bool: Indicates whether to use common alert schema.

GetActionGroupSmsReceiver

CountryCode string: The country code of the voice receiver.
Name string: Specifies the name of the Action Group.
PhoneNumber string: The phone number of the voice receiver.

CountryCode string: The country code of the voice receiver.
Name string: Specifies the name of the Action Group.
PhoneNumber string: The phone number of the voice receiver.

countryCode string: The country code of the voice receiver.
name string: Specifies the name of the Action Group.
phoneNumber string: The phone number of the voice receiver.

countryCode str: The country code of the voice receiver.
name str: Specifies the name of the Action Group.
phoneNumber str: The phone number of the voice receiver.

GetActionGroupVoiceReceiver

CountryCode string: The country code of the voice receiver.
Name string: Specifies the name of the Action Group.
PhoneNumber string: The phone number of the voice receiver.

CountryCode string: The country code of the voice receiver.
Name string: Specifies the name of the Action Group.
PhoneNumber string: The phone number of the voice receiver.

countryCode string: The country code of the voice receiver.
name string: Specifies the name of the Action Group.
phoneNumber string: The phone number of the voice receiver.

countryCode str: The country code of the voice receiver.
name str: Specifies the name of the Action Group.
phoneNumber str: The phone number of the voice receiver.

GetActionGroupWebhookReceiver

Name string: Specifies the name of the Action Group.
ServiceUri string: The URI where webhooks should be sent.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

Name string: Specifies the name of the Action Group.
ServiceUri string: The URI where webhooks should be sent.
UseCommonAlertSchema bool: Indicates whether to use common alert schema.

name string: Specifies the name of the Action Group.
serviceUri string: The URI where webhooks should be sent.
useCommonAlertSchema boolean: Indicates whether to use common alert schema.

name str: Specifies the name of the Action Group.
service_uri str: The URI where webhooks should be sent.
useCommonAlertSchema bool: Indicates whether to use common alert schema.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetActionGroup

Example Usage

Using GetActionGroup

GetActionGroup Result

Supporting Types

GetActionGroupArmRoleReceiver

GetActionGroupAutomationRunbookReceiver

GetActionGroupAzureAppPushReceiver

GetActionGroupAzureFunctionReceiver

GetActionGroupEmailReceiver

GetActionGroupItsmReceiver

GetActionGroupLogicAppReceiver

GetActionGroupSmsReceiver

GetActionGroupVoiceReceiver

GetActionGroupWebhookReceiver

Package Details

On This Page