Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Azure Native

v1.42.0 published on Monday, Oct 25, 2021 by Pulumi

getActionGroup

An action group resource. API Version: 2019-06-01.

Using getActionGroup

function getActionGroup(args: GetActionGroupArgs, opts?: InvokeOptions): Promise<GetActionGroupResult>
def get_action_group(action_group_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetActionGroupResult
func LookupActionGroup(ctx *Context, args *LookupActionGroupArgs, opts ...InvokeOption) (*LookupActionGroupResult, error)

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

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

The following arguments are supported:

ActionGroupName string
The name of the action group.
ResourceGroupName string
The name of the resource group.
ActionGroupName string
The name of the action group.
ResourceGroupName string
The name of the resource group.
actionGroupName string
The name of the action group.
resourceGroupName string
The name of the resource group.
action_group_name str
The name of the action group.
resource_group_name str
The name of the resource group.

getActionGroup Result

The following output properties are available:

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
Identity string
Azure resource identity
Kind string
Azure resource kind
Location string
Resource location
Name string
Azure resource name
Type string
Azure resource type
ArmRoleReceivers List<Pulumi.AzureNative.Insights.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.Insights.Outputs.AutomationRunbookReceiverResponse>
The list of AutomationRunbook receivers that are part of this action group.
AzureAppPushReceivers List<Pulumi.AzureNative.Insights.Outputs.AzureAppPushReceiverResponse>
The list of AzureAppPush receivers that are part of this action group.
AzureFunctionReceivers List<Pulumi.AzureNative.Insights.Outputs.AzureFunctionReceiverResponse>
The list of azure function receivers that are part of this action group.
EmailReceivers List<Pulumi.AzureNative.Insights.Outputs.EmailReceiverResponse>
The list of email receivers that are part of this action group.
ItsmReceivers List<Pulumi.AzureNative.Insights.Outputs.ItsmReceiverResponse>
The list of ITSM receivers that are part of this action group.
LogicAppReceivers List<Pulumi.AzureNative.Insights.Outputs.LogicAppReceiverResponse>
The list of logic app receivers that are part of this action group.
SmsReceivers List<Pulumi.AzureNative.Insights.Outputs.SmsReceiverResponse>
The list of SMS receivers that are part of this action group.
Tags Dictionary<string, string>
Resource tags
VoiceReceivers List<Pulumi.AzureNative.Insights.Outputs.VoiceReceiverResponse>
The list of voice receivers that are part of this action group.
WebhookReceivers List<Pulumi.AzureNative.Insights.Outputs.WebhookReceiverResponse>
The list of webhook receivers that are part of this action group.
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
Identity string
Azure resource identity
Kind string
Azure resource kind
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.
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.
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
identity string
Azure resource identity
kind string
Azure resource kind
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.
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.
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
identity str
Azure resource identity
kind str
Azure resource kind
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.
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.

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 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.

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.
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.
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.
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.
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.

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 an 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 an 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 an 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 an 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.
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.
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.
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.
use_common_alert_schema bool
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 an 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 an 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 an 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 an action group.
status str
The receiver status of the e-mail.
use_common_alert_schema bool
Indicates whether to use common alert schema.

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.
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.

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.
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.
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.
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.
use_common_alert_schema bool
Indicates whether to use common alert schema.

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 an 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 an 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 an 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 an action group.
phone_number str
The phone number of the SMS receiver.
status str
The status of the receiver.

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 an 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 an 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 an 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 an action group.
phone_number str
The phone number of the voice receiver.

WebhookReceiverResponse

Name string
The name of the webhook receiver. Names must be unique across all receivers within an action group.
ServiceUri string
The URI where webhooks should be sent.
IdentifierUri string
Indicates the identifier uri for aad auth.
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 an action group.
ServiceUri string
The URI where webhooks should be sent.
IdentifierUri string
Indicates the identifier uri for aad auth.
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 an action group.
serviceUri string
The URI where webhooks should be sent.
identifierUri string
Indicates the identifier uri for aad auth.
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 an action group.
service_uri str
The URI where webhooks should be sent.
identifier_uri str
Indicates the identifier uri for aad auth.
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.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0