Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. insights
  5. getTenantActionGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.insights.getTenantActionGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

    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>
    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]
    func LookupTenantActionGroup(ctx *Context, args *LookupTenantActionGroupArgs, opts ...InvokeOption) (*LookupTenantActionGroupResult, error)
func LookupTenantActionGroupOutput(ctx *Context, args *LookupTenantActionGroupOutputArgs, opts ...InvokeOption) LookupTenantActionGroupResultOutput

    > 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)
}
    public static CompletableFuture<GetTenantActionGroupResult> getTenantActionGroup(GetTenantActionGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:insights:getTenantActionGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ManagementGroupId string
    The management group id.
    TenantActionGroupName string
    The name of the action group.
    ManagementGroupId string
    The management group id.
    TenantActionGroupName string
    The name of the action group.
    managementGroupId String
    The management group id.
    tenantActionGroupName String
    The name of the action group.
    managementGroupId string
    The management group id.
    tenantActionGroupName string
    The name of the action group.
    management_group_id str
    The management group id.
    tenant_action_group_name str
    The name of the action group.
    managementGroupId String
    The management group id.
    tenantActionGroupName 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 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.

    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.

    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.

    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.
    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.
    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.
    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.
    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.
    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.
    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native