1. Packages
  2. Prismacloud Provider
  3. API Docs
  4. getNotificationTemplate
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks

prismacloud.getNotificationTemplate

Explore with Pulumi AI

prismacloud logo
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks

    Retrieve information on a specific notification template.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as prismacloud from "@pulumi/prismacloud";
    
    const example = prismacloud.getNotificationTemplate({
        id: "<notification-template-id>",
    });
    
    import pulumi
    import pulumi_prismacloud as prismacloud
    
    example = prismacloud.get_notification_template(id="<notification-template-id>")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prismacloud/prismacloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := prismacloud.LookupNotificationTemplate(ctx, &prismacloud.LookupNotificationTemplateArgs{
    			Id: "<notification-template-id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Prismacloud = Pulumi.Prismacloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Prismacloud.GetNotificationTemplate.Invoke(new()
        {
            Id = "<notification-template-id>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.prismacloud.PrismacloudFunctions;
    import com.pulumi.prismacloud.inputs.GetNotificationTemplateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = PrismacloudFunctions.getNotificationTemplate(GetNotificationTemplateArgs.builder()
                .id("<notification-template-id>")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: prismacloud:getNotificationTemplate
          arguments:
            id: <notification-template-id>
    

    Template Config

    • basic_config - This field includes additional attributes that can be used to customize the notification, as defined below.
    • open - Provide config to map the open alert state to jira/service_now state and configure the jira/service_now fields. This field includes additional attributes, as defined below.
    • resolved - Provide config to map the resolved alert state to jira/service_now state and configure the jira/service_now fields. This field includes additional attributes, as defined below.
    • dismissed - Provide config to map the dismissed alert state to service_now state and configure the service_now fields. This field includes additional attributes, as defined below.
    • snoozed - This field represents the notification status when the user has chosen to temporarily delay or “snooze” the notification. This field includes additional attributes, as defined below.

    Config Params

    • field_name - Field name.
    • display_name - Display name.
    • redlock_mapping - (bool) Prisma Cloud will provide the field value for notification.
    • required - (bool) Required.
    • type_ahead_uri - URL used to query suggestions for field value.
    • type - Type of field.
    • value - Field value.
    • alias_field - Alias field.
    • max_length - (int) Maximum length.
    • options - Options, as defined below.

    Options

    • name - Field option name.
    • key - Field option key.
    • id - Field option ID.

    Using getNotificationTemplate

    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 getNotificationTemplate(args: GetNotificationTemplateArgs, opts?: InvokeOptions): Promise<GetNotificationTemplateResult>
    function getNotificationTemplateOutput(args: GetNotificationTemplateOutputArgs, opts?: InvokeOptions): Output<GetNotificationTemplateResult>
    def get_notification_template(id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetNotificationTemplateResult
    def get_notification_template_output(id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetNotificationTemplateResult]
    func LookupNotificationTemplate(ctx *Context, args *LookupNotificationTemplateArgs, opts ...InvokeOption) (*LookupNotificationTemplateResult, error)
    func LookupNotificationTemplateOutput(ctx *Context, args *LookupNotificationTemplateOutputArgs, opts ...InvokeOption) LookupNotificationTemplateResultOutput

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

    public static class GetNotificationTemplate 
    {
        public static Task<GetNotificationTemplateResult> InvokeAsync(GetNotificationTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetNotificationTemplateResult> Invoke(GetNotificationTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNotificationTemplateResult> getNotificationTemplate(GetNotificationTemplateArgs args, InvokeOptions options)
    public static Output<GetNotificationTemplateResult> getNotificationTemplate(GetNotificationTemplateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: prismacloud:index/getNotificationTemplate:getNotificationTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Notification template ID.
    Id string
    Notification template ID.
    id String
    Notification template ID.
    id string
    Notification template ID.
    id str
    Notification template ID.
    id String
    Notification template ID.

    getNotificationTemplate Result

    The following output properties are available:

    CreatedBy string
    User who created the notification template.
    CreatedTs double
    (int) Creation Unix timestamp in milliseconds.
    CustomerId double
    (int) Prisma customer ID.
    Enabled bool
    (bool) Whether the template is enabled.
    Id string
    IntegrationId string
    Integration ID.
    IntegrationName string
    Integration name.
    IntegrationType string
    Integration type.
    LastModifiedBy string
    Last modified by.
    LastModifiedTs double
    (int) Last modified timestamp.
    Module string
    Module.
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    TemplateConfigs List<GetNotificationTemplateTemplateConfig>
    Template config spec, as defined below.
    TemplateType string
    Type of notification template.
    CreatedBy string
    User who created the notification template.
    CreatedTs float64
    (int) Creation Unix timestamp in milliseconds.
    CustomerId float64
    (int) Prisma customer ID.
    Enabled bool
    (bool) Whether the template is enabled.
    Id string
    IntegrationId string
    Integration ID.
    IntegrationName string
    Integration name.
    IntegrationType string
    Integration type.
    LastModifiedBy string
    Last modified by.
    LastModifiedTs float64
    (int) Last modified timestamp.
    Module string
    Module.
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    TemplateConfigs []GetNotificationTemplateTemplateConfig
    Template config spec, as defined below.
    TemplateType string
    Type of notification template.
    createdBy String
    User who created the notification template.
    createdTs Double
    (int) Creation Unix timestamp in milliseconds.
    customerId Double
    (int) Prisma customer ID.
    enabled Boolean
    (bool) Whether the template is enabled.
    id String
    integrationId String
    Integration ID.
    integrationName String
    Integration name.
    integrationType String
    Integration type.
    lastModifiedBy String
    Last modified by.
    lastModifiedTs Double
    (int) Last modified timestamp.
    module String
    Module.
    name String
    Name to be used for the template on the Prisma Cloud platform.
    templateConfigs List<GetNotificationTemplateTemplateConfig>
    Template config spec, as defined below.
    templateType String
    Type of notification template.
    createdBy string
    User who created the notification template.
    createdTs number
    (int) Creation Unix timestamp in milliseconds.
    customerId number
    (int) Prisma customer ID.
    enabled boolean
    (bool) Whether the template is enabled.
    id string
    integrationId string
    Integration ID.
    integrationName string
    Integration name.
    integrationType string
    Integration type.
    lastModifiedBy string
    Last modified by.
    lastModifiedTs number
    (int) Last modified timestamp.
    module string
    Module.
    name string
    Name to be used for the template on the Prisma Cloud platform.
    templateConfigs GetNotificationTemplateTemplateConfig[]
    Template config spec, as defined below.
    templateType string
    Type of notification template.
    created_by str
    User who created the notification template.
    created_ts float
    (int) Creation Unix timestamp in milliseconds.
    customer_id float
    (int) Prisma customer ID.
    enabled bool
    (bool) Whether the template is enabled.
    id str
    integration_id str
    Integration ID.
    integration_name str
    Integration name.
    integration_type str
    Integration type.
    last_modified_by str
    Last modified by.
    last_modified_ts float
    (int) Last modified timestamp.
    module str
    Module.
    name str
    Name to be used for the template on the Prisma Cloud platform.
    template_configs Sequence[GetNotificationTemplateTemplateConfig]
    Template config spec, as defined below.
    template_type str
    Type of notification template.
    createdBy String
    User who created the notification template.
    createdTs Number
    (int) Creation Unix timestamp in milliseconds.
    customerId Number
    (int) Prisma customer ID.
    enabled Boolean
    (bool) Whether the template is enabled.
    id String
    integrationId String
    Integration ID.
    integrationName String
    Integration name.
    integrationType String
    Integration type.
    lastModifiedBy String
    Last modified by.
    lastModifiedTs Number
    (int) Last modified timestamp.
    module String
    Module.
    name String
    Name to be used for the template on the Prisma Cloud platform.
    templateConfigs List<Property Map>
    Template config spec, as defined below.
    templateType String
    Type of notification template.

    Supporting Types

    GetNotificationTemplateTemplateConfig

    GetNotificationTemplateTemplateConfigBasicConfig

    GetNotificationTemplateTemplateConfigBasicConfigOption

    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.
    id string
    Notification template ID.
    key string
    name string
    Name to be used for the template on the Prisma Cloud platform.
    id str
    Notification template ID.
    key str
    name str
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.

    GetNotificationTemplateTemplateConfigDismissed

    GetNotificationTemplateTemplateConfigDismissedOption

    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.
    id string
    Notification template ID.
    key string
    name string
    Name to be used for the template on the Prisma Cloud platform.
    id str
    Notification template ID.
    key str
    name str
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.

    GetNotificationTemplateTemplateConfigOpen

    GetNotificationTemplateTemplateConfigOpenOption

    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.
    id string
    Notification template ID.
    key string
    name string
    Name to be used for the template on the Prisma Cloud platform.
    id str
    Notification template ID.
    key str
    name str
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.

    GetNotificationTemplateTemplateConfigResolved

    GetNotificationTemplateTemplateConfigResolvedOption

    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.
    id string
    Notification template ID.
    key string
    name string
    Name to be used for the template on the Prisma Cloud platform.
    id str
    Notification template ID.
    key str
    name str
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.

    GetNotificationTemplateTemplateConfigSnoozed

    GetNotificationTemplateTemplateConfigSnoozedOption

    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    Id string
    Notification template ID.
    Key string
    Name string
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.
    id string
    Notification template ID.
    key string
    name string
    Name to be used for the template on the Prisma Cloud platform.
    id str
    Notification template ID.
    key str
    name str
    Name to be used for the template on the Prisma Cloud platform.
    id String
    Notification template ID.
    key String
    name String
    Name to be used for the template on the Prisma Cloud platform.

    Package Details

    Repository
    prismacloud paloaltonetworks/terraform-provider-prismacloud
    License
    Notes
    This Pulumi package is based on the prismacloud Terraform Provider.
    prismacloud logo
    prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks