1. Packages
  2. Azure Native v2
  3. API Docs
  4. insights
  5. getTenantActionGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.insights.getTenantActionGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Get a tenant action group. Azure REST API version: 2023-05-01-preview.

Using getTenantActionGroup

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.

function getTenantActionGroup(args: GetTenantActionGroupArgs, opts?: InvokeOptions): Promise<GetTenantActionGroupResult>
function getTenantActionGroupOutput(args: GetTenantActionGroupOutputArgs, opts?: InvokeOptions): Output<GetTenantActionGroupResult>
Copy
def get_tenant_action_group(management_group_id: Optional[str] = None,
                            tenant_action_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetTenantActionGroupResult
def get_tenant_action_group_output(management_group_id: Optional[pulumi.Input[str]] = None,
                            tenant_action_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetTenantActionGroupResult]
Copy
func LookupTenantActionGroup(ctx *Context, args *LookupTenantActionGroupArgs, opts ...InvokeOption) (*LookupTenantActionGroupResult, error)
func LookupTenantActionGroupOutput(ctx *Context, args *LookupTenantActionGroupOutputArgs, opts ...InvokeOption) LookupTenantActionGroupResultOutput
Copy

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

public static class GetTenantActionGroup 
{
    public static Task<GetTenantActionGroupResult> InvokeAsync(GetTenantActionGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetTenantActionGroupResult> Invoke(GetTenantActionGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTenantActionGroupResult> getTenantActionGroup(GetTenantActionGroupArgs args, InvokeOptions options)
public static Output<GetTenantActionGroupResult> getTenantActionGroup(GetTenantActionGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:insights:getTenantActionGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ManagementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The management group id.
TenantActionGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the action group.
ManagementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The management group id.
TenantActionGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the action group.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
String
The management group id.
tenantActionGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the action group.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
string
The management group id.
tenantActionGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the action group.
management_group_id
This property is required.
Changes to this property will trigger replacement.
str
The management group id.
tenant_action_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the action group.
managementGroupId
This property is required.
Changes to this property will trigger replacement.
String
The management group id.
tenantActionGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the action group.

getTenantActionGroup Result

The following output properties are available:

Enabled bool
Indicates whether this tenant action group is enabled. If a tenant 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
AzureAppPushReceivers List<Pulumi.AzureNative.Insights.Outputs.AzureAppPushReceiverResponse>
The list of AzureAppPush receivers that are part of this tenant action group.
EmailReceivers List<Pulumi.AzureNative.Insights.Outputs.EmailReceiverResponse>
The list of email receivers that are part of this tenant action group.
SmsReceivers List<Pulumi.AzureNative.Insights.Outputs.SmsReceiverResponse>
The list of SMS receivers that are part of this tenant 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 tenant action group.
WebhookReceivers List<Pulumi.AzureNative.Insights.Outputs.WebhookReceiverResponse>
The list of webhook receivers that are part of this tenant action group.
Enabled bool
Indicates whether this tenant action group is enabled. If a tenant 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
AzureAppPushReceivers []AzureAppPushReceiverResponse
The list of AzureAppPush receivers that are part of this tenant action group.
EmailReceivers []EmailReceiverResponse
The list of email receivers that are part of this tenant action group.
SmsReceivers []SmsReceiverResponse
The list of SMS receivers that are part of this tenant action group.
Tags map[string]string
Resource tags
VoiceReceivers []VoiceReceiverResponse
The list of voice receivers that are part of this tenant action group.
WebhookReceivers []WebhookReceiverResponse
The list of webhook receivers that are part of this tenant action group.
enabled Boolean
Indicates whether this tenant action group is enabled. If a tenant 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
azureAppPushReceivers List<AzureAppPushReceiverResponse>
The list of AzureAppPush receivers that are part of this tenant action group.
emailReceivers List<EmailReceiverResponse>
The list of email receivers that are part of this tenant action group.
smsReceivers List<SmsReceiverResponse>
The list of SMS receivers that are part of this tenant action group.
tags Map<String,String>
Resource tags
voiceReceivers List<VoiceReceiverResponse>
The list of voice receivers that are part of this tenant action group.
webhookReceivers List<WebhookReceiverResponse>
The list of webhook receivers that are part of this tenant action group.
enabled boolean
Indicates whether this tenant action group is enabled. If a tenant 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
azureAppPushReceivers AzureAppPushReceiverResponse[]
The list of AzureAppPush receivers that are part of this tenant action group.
emailReceivers EmailReceiverResponse[]
The list of email receivers that are part of this tenant action group.
smsReceivers SmsReceiverResponse[]
The list of SMS receivers that are part of this tenant action group.
tags {[key: string]: string}
Resource tags
voiceReceivers VoiceReceiverResponse[]
The list of voice receivers that are part of this tenant action group.
webhookReceivers WebhookReceiverResponse[]
The list of webhook receivers that are part of this tenant action group.
enabled bool
Indicates whether this tenant action group is enabled. If a tenant 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
azure_app_push_receivers Sequence[AzureAppPushReceiverResponse]
The list of AzureAppPush receivers that are part of this tenant action group.
email_receivers Sequence[EmailReceiverResponse]
The list of email receivers that are part of this tenant action group.
sms_receivers Sequence[SmsReceiverResponse]
The list of SMS receivers that are part of this tenant action group.
tags Mapping[str, str]
Resource tags
voice_receivers Sequence[VoiceReceiverResponse]
The list of voice receivers that are part of this tenant action group.
webhook_receivers Sequence[WebhookReceiverResponse]
The list of webhook receivers that are part of this tenant action group.
enabled Boolean
Indicates whether this tenant action group is enabled. If a tenant 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
azureAppPushReceivers List<Property Map>
The list of AzureAppPush receivers that are part of this tenant action group.
emailReceivers List<Property Map>
The list of email receivers that are part of this tenant action group.
smsReceivers List<Property Map>
The list of SMS receivers that are part of this tenant action group.
tags Map<String>
Resource tags
voiceReceivers List<Property Map>
The list of voice receivers that are part of this tenant action group.
webhookReceivers List<Property Map>
The list of webhook receivers that are part of this tenant action group.

Supporting Types

AzureAppPushReceiverResponse

EmailAddress This property is required. string
The email address registered for the Azure mobile app.
Name This property is required. string
The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.
EmailAddress This property is required. string
The email address registered for the Azure mobile app.
Name This property is required. string
The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.
emailAddress This property is required. String
The email address registered for the Azure mobile app.
name This property is required. String
The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.
emailAddress This property is required. string
The email address registered for the Azure mobile app.
name This property is required. string
The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.
email_address This property is required. str
The email address registered for the Azure mobile app.
name This property is required. str
The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.
emailAddress This property is required. String
The email address registered for the Azure mobile app.
name This property is required. String
The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group.

EmailReceiverResponse

EmailAddress This property is required. string
The email address of this receiver.
Name This property is required. string
The name of the email receiver. Names must be unique across all receivers within a tenant action group.
Status This property is required. string
The receiver status of the e-mail.
UseCommonAlertSchema bool
Indicates whether to use common alert schema.
EmailAddress This property is required. string
The email address of this receiver.
Name This property is required. string
The name of the email receiver. Names must be unique across all receivers within a tenant action group.
Status This property is required. string
The receiver status of the e-mail.
UseCommonAlertSchema bool
Indicates whether to use common alert schema.
emailAddress This property is required. String
The email address of this receiver.
name This property is required. String
The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status This property is required. String
The receiver status of the e-mail.
useCommonAlertSchema Boolean
Indicates whether to use common alert schema.
emailAddress This property is required. string
The email address of this receiver.
name This property is required. string
The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status This property is required. string
The receiver status of the e-mail.
useCommonAlertSchema boolean
Indicates whether to use common alert schema.
email_address This property is required. str
The email address of this receiver.
name This property is required. str
The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status This property is required. str
The receiver status of the e-mail.
use_common_alert_schema bool
Indicates whether to use common alert schema.
emailAddress This property is required. String
The email address of this receiver.
name This property is required. String
The name of the email receiver. Names must be unique across all receivers within a tenant action group.
status This property is required. String
The receiver status of the e-mail.
useCommonAlertSchema Boolean
Indicates whether to use common alert schema.

SmsReceiverResponse

CountryCode This property is required. string
The country code of the SMS receiver.
Name This property is required. string
The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber This property is required. string
The phone number of the SMS receiver.
Status This property is required. string
The status of the receiver.
CountryCode This property is required. string
The country code of the SMS receiver.
Name This property is required. string
The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber This property is required. string
The phone number of the SMS receiver.
Status This property is required. string
The status of the receiver.
countryCode This property is required. String
The country code of the SMS receiver.
name This property is required. String
The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber This property is required. String
The phone number of the SMS receiver.
status This property is required. String
The status of the receiver.
countryCode This property is required. string
The country code of the SMS receiver.
name This property is required. string
The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber This property is required. string
The phone number of the SMS receiver.
status This property is required. string
The status of the receiver.
country_code This property is required. str
The country code of the SMS receiver.
name This property is required. str
The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phone_number This property is required. str
The phone number of the SMS receiver.
status This property is required. str
The status of the receiver.
countryCode This property is required. String
The country code of the SMS receiver.
name This property is required. String
The name of the SMS receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber This property is required. String
The phone number of the SMS receiver.
status This property is required. String
The status of the receiver.

VoiceReceiverResponse

CountryCode This property is required. string
The country code of the voice receiver.
Name This property is required. string
The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber This property is required. string
The phone number of the voice receiver.
CountryCode This property is required. string
The country code of the voice receiver.
Name This property is required. string
The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
PhoneNumber This property is required. string
The phone number of the voice receiver.
countryCode This property is required. String
The country code of the voice receiver.
name This property is required. String
The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber This property is required. String
The phone number of the voice receiver.
countryCode This property is required. string
The country code of the voice receiver.
name This property is required. string
The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber This property is required. string
The phone number of the voice receiver.
country_code This property is required. str
The country code of the voice receiver.
name This property is required. str
The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phone_number This property is required. str
The phone number of the voice receiver.
countryCode This property is required. String
The country code of the voice receiver.
name This property is required. String
The name of the voice receiver. Names must be unique across all receivers within a tenant action group.
phoneNumber This property is required. String
The phone number of the voice receiver.

WebhookReceiverResponse

Name This property is required. string
The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
ServiceUri This property is required. 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 This property is required. string
The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
ServiceUri This property is required. 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 This property is required. String
The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
serviceUri This property is required. 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 This property is required. string
The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
serviceUri This property is required. 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 This property is required. str
The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
service_uri This property is required. 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.
name This property is required. String
The name of the webhook receiver. Names must be unique across all receivers within a tenant action group.
serviceUri This property is required. 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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi