Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prismacloud Provider
  3. API Docs
  4. getAlerts
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-prismacloud

prismacloud.getAlerts

Explore with Pulumi AI

prismacloud logo
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-prismacloud

    Data source to return information on current alerts in Prisma Cloud.

    Example Usage

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

const info = prismacloud.getAlerts({
    limit: 2,
    timeRange: {
        relatives: [{
            amount: 48,
            unit: "hour",
        }],
    },
});
export const alerts = info.then(info => info.listings);

    import pulumi
import pulumi_prismacloud as prismacloud

info = prismacloud.get_alerts(limit=2,
    time_range={
        "relatives": [{
            "amount": 48,
            "unit": "hour",
        }],
    })
pulumi.export("alerts", info.listings)

    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 {
		info, err := prismacloud.GetAlerts(ctx, &prismacloud.GetAlertsArgs{
			Limit: pulumi.Float64Ref(2),
			TimeRange: prismacloud.GetAlertsTimeRange{
				Relatives: []prismacloud.GetAlertsTimeRangeRelative{
					{
						Amount: 48,
						Unit:   "hour",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("alerts", info.Listings)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prismacloud = Pulumi.Prismacloud;

return await Deployment.RunAsync(() => 
{
    var info = Prismacloud.GetAlerts.Invoke(new()
    {
        Limit = 2,
        TimeRange = new Prismacloud.Inputs.GetAlertsTimeRangeInputArgs
        {
            Relatives = new[]
            {
                new Prismacloud.Inputs.GetAlertsTimeRangeRelativeInputArgs
                {
                    Amount = 48,
                    Unit = "hour",
                },
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["alerts"] = info.Apply(getAlertsResult => getAlertsResult.Listings),
    };
});

    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.GetAlertsArgs;
import com.pulumi.prismacloud.inputs.GetAlertsTimeRangeArgs;
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 info = PrismacloudFunctions.getAlerts(GetAlertsArgs.builder()
            .limit(2)
            .timeRange(GetAlertsTimeRangeArgs.builder()
                .relatives(GetAlertsTimeRangeRelativeArgs.builder()
                    .amount(48)
                    .unit("hour")
                    .build())
                .build())
            .build());

        ctx.export("alerts", info.applyValue(getAlertsResult -> getAlertsResult.listings()));
    }
}

    variables:
  info:
    fn::invoke:
      function: prismacloud:getAlerts
      arguments:
        limit: 2
        timeRange:
          relatives:
            - amount: 48
              unit: hour
outputs:
  alerts: ${info.listings}

    Using getAlerts

    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 getAlerts(args: GetAlertsArgs, opts?: InvokeOptions): Promise<GetAlertsResult>
function getAlertsOutput(args: GetAlertsOutputArgs, opts?: InvokeOptions): Output<GetAlertsResult>
    def get_alerts(filters: Optional[Sequence[GetAlertsFilter]] = None,
               id: Optional[str] = None,
               limit: Optional[float] = None,
               sort_bies: Optional[Sequence[str]] = None,
               time_range: Optional[GetAlertsTimeRange] = None,
               opts: Optional[InvokeOptions] = None) -> GetAlertsResult
def get_alerts_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAlertsFilterArgs]]]] = None,
               id: Optional[pulumi.Input[str]] = None,
               limit: Optional[pulumi.Input[float]] = None,
               sort_bies: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               time_range: Optional[pulumi.Input[GetAlertsTimeRangeArgs]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetAlertsResult]
    func GetAlerts(ctx *Context, args *GetAlertsArgs, opts ...InvokeOption) (*GetAlertsResult, error)
func GetAlertsOutput(ctx *Context, args *GetAlertsOutputArgs, opts ...InvokeOption) GetAlertsResultOutput

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

    public static class GetAlerts 
{
    public static Task<GetAlertsResult> InvokeAsync(GetAlertsArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertsResult> Invoke(GetAlertsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAlertsResult> getAlerts(GetAlertsArgs args, InvokeOptions options)
public static Output<GetAlertsResult> getAlerts(GetAlertsArgs args, InvokeOptions options)

    fn::invoke:
  function: prismacloud:index/getAlerts:getAlerts
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetAlertsFilter>
    Filtering parameters spec, as defined below.
    Id string
    Limit double
    Max number of alerts to return (default: 10000).
    SortBies List<string>
    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively.
    TimeRange GetAlertsTimeRange
    The time range spec, as defined below.
    Filters []GetAlertsFilter
    Filtering parameters spec, as defined below.
    Id string
    Limit float64
    Max number of alerts to return (default: 10000).
    SortBies []string
    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively.
    TimeRange GetAlertsTimeRange
    The time range spec, as defined below.
    filters List<GetAlertsFilter>
    Filtering parameters spec, as defined below.
    id String
    limit Double
    Max number of alerts to return (default: 10000).
    sortBies List<String>
    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively.
    timeRange GetAlertsTimeRange
    The time range spec, as defined below.
    filters GetAlertsFilter[]
    Filtering parameters spec, as defined below.
    id string
    limit number
    Max number of alerts to return (default: 10000).
    sortBies string[]
    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively.
    timeRange GetAlertsTimeRange
    The time range spec, as defined below.
    filters Sequence[GetAlertsFilter]
    Filtering parameters spec, as defined below.
    id str
    limit float
    Max number of alerts to return (default: 10000).
    sort_bies Sequence[str]
    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively.
    time_range GetAlertsTimeRange
    The time range spec, as defined below.
    filters List<Property Map>
    Filtering parameters spec, as defined below.
    id String
    limit Number
    Max number of alerts to return (default: 10000).
    sortBies List<String>
    Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively.
    timeRange Property Map
    The time range spec, as defined below.

    getAlerts Result

    The following output properties are available:

    Id string
    Listings List<GetAlertsListing>
    Alert listing, as defined below.
    PageToken string
    The next page token returned.
    Total double
    (int) Total number of alerts returned.
    Filters List<GetAlertsFilter>
    Limit double
    SortBies List<string>
    TimeRange GetAlertsTimeRange
    Id string
    Listings []GetAlertsListing
    Alert listing, as defined below.
    PageToken string
    The next page token returned.
    Total float64
    (int) Total number of alerts returned.
    Filters []GetAlertsFilter
    Limit float64
    SortBies []string
    TimeRange GetAlertsTimeRange
    id String
    listings List<GetAlertsListing>
    Alert listing, as defined below.
    pageToken String
    The next page token returned.
    total Double
    (int) Total number of alerts returned.
    filters List<GetAlertsFilter>
    limit Double
    sortBies List<String>
    timeRange GetAlertsTimeRange
    id string
    listings GetAlertsListing[]
    Alert listing, as defined below.
    pageToken string
    The next page token returned.
    total number
    (int) Total number of alerts returned.
    filters GetAlertsFilter[]
    limit number
    sortBies string[]
    timeRange GetAlertsTimeRange
    id str
    listings Sequence[GetAlertsListing]
    Alert listing, as defined below.
    page_token str
    The next page token returned.
    total float
    (int) Total number of alerts returned.
    filters Sequence[GetAlertsFilter]
    limit float
    sort_bies Sequence[str]
    time_range GetAlertsTimeRange
    id String
    listings List<Property Map>
    Alert listing, as defined below.
    pageToken String
    The next page token returned.
    total Number
    (int) Total number of alerts returned.
    filters List<Property Map>
    limit Number
    sortBies List<String>
    timeRange Property Map

    Supporting Types

    GetAlertsFilter

    Name string
    Param name to filter on.
    Value string
    Param value for the filter.
    Operator string
    Operator between the name and value params (default: =).
    Name string
    Param name to filter on.
    Value string
    Param value for the filter.
    Operator string
    Operator between the name and value params (default: =).
    name String
    Param name to filter on.
    value String
    Param value for the filter.
    operator String
    Operator between the name and value params (default: =).
    name string
    Param name to filter on.
    value string
    Param value for the filter.
    operator string
    Operator between the name and value params (default: =).
    name str
    Param name to filter on.
    value str
    Param value for the filter.
    operator str
    Operator between the name and value params (default: =).
    name String
    Param name to filter on.
    value String
    Param value for the filter.
    operator String
    Operator between the name and value params (default: =).

    GetAlertsListing

    AlertCount double
    (int) Alert count.
    AlertId string
    Alert ID.
    AlertTime double
    (int) Alert time.
    EventOccurred double
    (int) Event occurred.
    FirstSeen double
    (int) First seen.
    LastSeen double
    (int) Last seen.
    Status string
    Alert status.
    TriggeredBy string
    Triggered by.
    AlertCount float64
    (int) Alert count.
    AlertId string
    Alert ID.
    AlertTime float64
    (int) Alert time.
    EventOccurred float64
    (int) Event occurred.
    FirstSeen float64
    (int) First seen.
    LastSeen float64
    (int) Last seen.
    Status string
    Alert status.
    TriggeredBy string
    Triggered by.
    alertCount Double
    (int) Alert count.
    alertId String
    Alert ID.
    alertTime Double
    (int) Alert time.
    eventOccurred Double
    (int) Event occurred.
    firstSeen Double
    (int) First seen.
    lastSeen Double
    (int) Last seen.
    status String
    Alert status.
    triggeredBy String
    Triggered by.
    alertCount number
    (int) Alert count.
    alertId string
    Alert ID.
    alertTime number
    (int) Alert time.
    eventOccurred number
    (int) Event occurred.
    firstSeen number
    (int) First seen.
    lastSeen number
    (int) Last seen.
    status string
    Alert status.
    triggeredBy string
    Triggered by.
    alert_count float
    (int) Alert count.
    alert_id str
    Alert ID.
    alert_time float
    (int) Alert time.
    event_occurred float
    (int) Event occurred.
    first_seen float
    (int) First seen.
    last_seen float
    (int) Last seen.
    status str
    Alert status.
    triggered_by str
    Triggered by.
    alertCount Number
    (int) Alert count.
    alertId String
    Alert ID.
    alertTime Number
    (int) Alert time.
    eventOccurred Number
    (int) Event occurred.
    firstSeen Number
    (int) First seen.
    lastSeen Number
    (int) Last seen.
    status String
    Alert status.
    triggeredBy String
    Triggered by.

    GetAlertsTimeRange

    Absolutes List<GetAlertsTimeRangeAbsolute>
    An absolute time range spec, as defined below.
    Relatives List<GetAlertsTimeRangeRelative>
    A relative time range spec, as defined below.
    ToNows List<GetAlertsTimeRangeToNow>
    A to-now time range spec, as defined below.
    Absolutes []GetAlertsTimeRangeAbsolute
    An absolute time range spec, as defined below.
    Relatives []GetAlertsTimeRangeRelative
    A relative time range spec, as defined below.
    ToNows []GetAlertsTimeRangeToNow
    A to-now time range spec, as defined below.
    absolutes List<GetAlertsTimeRangeAbsolute>
    An absolute time range spec, as defined below.
    relatives List<GetAlertsTimeRangeRelative>
    A relative time range spec, as defined below.
    toNows List<GetAlertsTimeRangeToNow>
    A to-now time range spec, as defined below.
    absolutes GetAlertsTimeRangeAbsolute[]
    An absolute time range spec, as defined below.
    relatives GetAlertsTimeRangeRelative[]
    A relative time range spec, as defined below.
    toNows GetAlertsTimeRangeToNow[]
    A to-now time range spec, as defined below.
    absolutes Sequence[GetAlertsTimeRangeAbsolute]
    An absolute time range spec, as defined below.
    relatives Sequence[GetAlertsTimeRangeRelative]
    A relative time range spec, as defined below.
    to_nows Sequence[GetAlertsTimeRangeToNow]
    A to-now time range spec, as defined below.
    absolutes List<Property Map>
    An absolute time range spec, as defined below.
    relatives List<Property Map>
    A relative time range spec, as defined below.
    toNows List<Property Map>
    A to-now time range spec, as defined below.

    GetAlertsTimeRangeAbsolute

    End double
    End time
    Start double
    Start time
    End float64
    End time
    Start float64
    Start time
    end Double
    End time
    start Double
    Start time
    end number
    End time
    start number
    Start time
    end float
    End time
    start float
    Start time
    end Number
    End time
    start Number
    Start time

    GetAlertsTimeRangeRelative

    Amount double
    The time number
    Unit string
    The time unit
    Amount float64
    The time number
    Unit string
    The time unit
    amount Double
    The time number
    unit String
    The time unit
    amount number
    The time number
    unit string
    The time unit
    amount float
    The time number
    unit str
    The time unit
    amount Number
    The time number
    unit String
    The time unit

    GetAlertsTimeRangeToNow

    Unit string
    The time unit
    Unit string
    The time unit
    unit String
    The time unit
    unit string
    The time unit
    unit str
    The time unit
    unit String
    The time unit

    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
    paloaltonetworks/terraform-provider-prismacloud