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

prismacloud.getReport

Explore with Pulumi AI

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

    Retrieve information on a specific alert report or compliance report.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as prismacloud from "@pulumi/prismacloud";
    
    const example = prismacloud.getReport({
        name: "My Report",
    });
    
    import pulumi
    import pulumi_prismacloud as prismacloud
    
    example = prismacloud.get_report(name="My Report")
    
    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.LookupReport(ctx, &prismacloud.LookupReportArgs{
    			Name: pulumi.StringRef("My Report"),
    		}, 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.GetReport.Invoke(new()
        {
            Name = "My Report",
        });
    
    });
    
    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.GetReportArgs;
    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.getReport(GetReportArgs.builder()
                .name("My Report")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: prismacloud:getReport
          arguments:
            name: My Report
    

    Using getReport

    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 getReport(args: GetReportArgs, opts?: InvokeOptions): Promise<GetReportResult>
    function getReportOutput(args: GetReportOutputArgs, opts?: InvokeOptions): Output<GetReportResult>
    def get_report(id: Optional[str] = None,
                   name: Optional[str] = None,
                   report_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetReportResult
    def get_report_output(id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   report_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetReportResult]
    func LookupReport(ctx *Context, args *LookupReportArgs, opts ...InvokeOption) (*LookupReportResult, error)
    func LookupReportOutput(ctx *Context, args *LookupReportOutputArgs, opts ...InvokeOption) LookupReportResultOutput

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

    public static class GetReport 
    {
        public static Task<GetReportResult> InvokeAsync(GetReportArgs args, InvokeOptions? opts = null)
        public static Output<GetReportResult> Invoke(GetReportInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetReportResult> getReport(GetReportArgs args, InvokeOptions options)
    public static Output<GetReportResult> getReport(GetReportArgs args, InvokeOptions options)
    
    fn::invoke:
      function: prismacloud:index/getReport:getReport
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    Report name
    ReportId string
    Report ID
    Id string
    Name string
    Report name
    ReportId string
    Report ID
    id String
    name String
    Report name
    reportId String
    Report ID
    id string
    name string
    Report name
    reportId string
    Report ID
    id str
    name str
    Report name
    report_id str
    Report ID
    id String
    name String
    Report name
    reportId String
    Report ID

    getReport Result

    The following output properties are available:

    CloudType string
    Cloud type
    ComplianceStandardId string
    Compliance Standard ID
    Counts List<GetReportCount>
    Model for compliance aggregate count, as defined below.
    CreatedBy string
    Created by
    CreatedOn double
    (int) Created on
    Id string
    LastModifiedBy string
    Last modified by
    LastModifiedOn double
    (int) Last modified on
    LastScheduled double
    (int) Last scheduled
    Name string
    NextSchedule double
    (int) Next schedule
    ReportId string
    ReportType string
    Report type
    Status string
    Report status
    Targets List<GetReportTarget>
    Model for report target, as defined below
    TotalInstanceCount double
    (int) Total instance count
    CloudType string
    Cloud type
    ComplianceStandardId string
    Compliance Standard ID
    Counts []GetReportCount
    Model for compliance aggregate count, as defined below.
    CreatedBy string
    Created by
    CreatedOn float64
    (int) Created on
    Id string
    LastModifiedBy string
    Last modified by
    LastModifiedOn float64
    (int) Last modified on
    LastScheduled float64
    (int) Last scheduled
    Name string
    NextSchedule float64
    (int) Next schedule
    ReportId string
    ReportType string
    Report type
    Status string
    Report status
    Targets []GetReportTarget
    Model for report target, as defined below
    TotalInstanceCount float64
    (int) Total instance count
    cloudType String
    Cloud type
    complianceStandardId String
    Compliance Standard ID
    counts List<GetReportCount>
    Model for compliance aggregate count, as defined below.
    createdBy String
    Created by
    createdOn Double
    (int) Created on
    id String
    lastModifiedBy String
    Last modified by
    lastModifiedOn Double
    (int) Last modified on
    lastScheduled Double
    (int) Last scheduled
    name String
    nextSchedule Double
    (int) Next schedule
    reportId String
    reportType String
    Report type
    status String
    Report status
    targets List<GetReportTarget>
    Model for report target, as defined below
    totalInstanceCount Double
    (int) Total instance count
    cloudType string
    Cloud type
    complianceStandardId string
    Compliance Standard ID
    counts GetReportCount[]
    Model for compliance aggregate count, as defined below.
    createdBy string
    Created by
    createdOn number
    (int) Created on
    id string
    lastModifiedBy string
    Last modified by
    lastModifiedOn number
    (int) Last modified on
    lastScheduled number
    (int) Last scheduled
    name string
    nextSchedule number
    (int) Next schedule
    reportId string
    reportType string
    Report type
    status string
    Report status
    targets GetReportTarget[]
    Model for report target, as defined below
    totalInstanceCount number
    (int) Total instance count
    cloud_type str
    Cloud type
    compliance_standard_id str
    Compliance Standard ID
    counts Sequence[GetReportCount]
    Model for compliance aggregate count, as defined below.
    created_by str
    Created by
    created_on float
    (int) Created on
    id str
    last_modified_by str
    Last modified by
    last_modified_on float
    (int) Last modified on
    last_scheduled float
    (int) Last scheduled
    name str
    next_schedule float
    (int) Next schedule
    report_id str
    report_type str
    Report type
    status str
    Report status
    targets Sequence[GetReportTarget]
    Model for report target, as defined below
    total_instance_count float
    (int) Total instance count
    cloudType String
    Cloud type
    complianceStandardId String
    Compliance Standard ID
    counts List<Property Map>
    Model for compliance aggregate count, as defined below.
    createdBy String
    Created by
    createdOn Number
    (int) Created on
    id String
    lastModifiedBy String
    Last modified by
    lastModifiedOn Number
    (int) Last modified on
    lastScheduled Number
    (int) Last scheduled
    name String
    nextSchedule Number
    (int) Next schedule
    reportId String
    reportType String
    Report type
    status String
    Report status
    targets List<Property Map>
    Model for report target, as defined below
    totalInstanceCount Number
    (int) Total instance count

    Supporting Types

    GetReportCount

    Failed double
    (int) Failed
    HighSeverityFailed double
    (int) Number of high-severity failures
    LowSeverityFailed double
    (int) Number of low-severity failures
    MediumSeverityFailed double
    (int) Number of medium-severity failures
    Passed double
    (int) Passed
    Total double
    (int) Total
    Failed float64
    (int) Failed
    HighSeverityFailed float64
    (int) Number of high-severity failures
    LowSeverityFailed float64
    (int) Number of low-severity failures
    MediumSeverityFailed float64
    (int) Number of medium-severity failures
    Passed float64
    (int) Passed
    Total float64
    (int) Total
    failed Double
    (int) Failed
    highSeverityFailed Double
    (int) Number of high-severity failures
    lowSeverityFailed Double
    (int) Number of low-severity failures
    mediumSeverityFailed Double
    (int) Number of medium-severity failures
    passed Double
    (int) Passed
    total Double
    (int) Total
    failed number
    (int) Failed
    highSeverityFailed number
    (int) Number of high-severity failures
    lowSeverityFailed number
    (int) Number of low-severity failures
    mediumSeverityFailed number
    (int) Number of medium-severity failures
    passed number
    (int) Passed
    total number
    (int) Total
    failed float
    (int) Failed
    high_severity_failed float
    (int) Number of high-severity failures
    low_severity_failed float
    (int) Number of low-severity failures
    medium_severity_failed float
    (int) Number of medium-severity failures
    passed float
    (int) Passed
    total float
    (int) Total
    failed Number
    (int) Failed
    highSeverityFailed Number
    (int) Number of high-severity failures
    lowSeverityFailed Number
    (int) Number of low-severity failures
    mediumSeverityFailed Number
    (int) Number of medium-severity failures
    passed Number
    (int) Passed
    total Number
    (int) Total

    GetReportTarget

    AccountGroups List<string>
    List of cloud account groups
    Accounts List<string>
    List of cloud accounts
    ComplianceStandardIds List<string>
    List of compliance standard IDs
    CompressionEnabled bool
    (bool) Business unit detailed report compression enabled
    DownloadNow bool
    (bool) True = download now
    NotificationTemplateId string
    Notification template id
    NotifyTos List<string>
    List of email addresses to receive notification
    Regions List<string>
    List of regions
    ResourceGroups List<string>
    List of resource groups
    Schedule string
    Recurring report schedule in RRULE format
    ScheduleEnabled bool
    (bool) Report scheduling enabled
    TimeRanges List<GetReportTargetTimeRange>
    (Required) The time range spec, as defined below.
    AccountGroups []string
    List of cloud account groups
    Accounts []string
    List of cloud accounts
    ComplianceStandardIds []string
    List of compliance standard IDs
    CompressionEnabled bool
    (bool) Business unit detailed report compression enabled
    DownloadNow bool
    (bool) True = download now
    NotificationTemplateId string
    Notification template id
    NotifyTos []string
    List of email addresses to receive notification
    Regions []string
    List of regions
    ResourceGroups []string
    List of resource groups
    Schedule string
    Recurring report schedule in RRULE format
    ScheduleEnabled bool
    (bool) Report scheduling enabled
    TimeRanges []GetReportTargetTimeRange
    (Required) The time range spec, as defined below.
    accountGroups List<String>
    List of cloud account groups
    accounts List<String>
    List of cloud accounts
    complianceStandardIds List<String>
    List of compliance standard IDs
    compressionEnabled Boolean
    (bool) Business unit detailed report compression enabled
    downloadNow Boolean
    (bool) True = download now
    notificationTemplateId String
    Notification template id
    notifyTos List<String>
    List of email addresses to receive notification
    regions List<String>
    List of regions
    resourceGroups List<String>
    List of resource groups
    schedule String
    Recurring report schedule in RRULE format
    scheduleEnabled Boolean
    (bool) Report scheduling enabled
    timeRanges List<GetReportTargetTimeRange>
    (Required) The time range spec, as defined below.
    accountGroups string[]
    List of cloud account groups
    accounts string[]
    List of cloud accounts
    complianceStandardIds string[]
    List of compliance standard IDs
    compressionEnabled boolean
    (bool) Business unit detailed report compression enabled
    downloadNow boolean
    (bool) True = download now
    notificationTemplateId string
    Notification template id
    notifyTos string[]
    List of email addresses to receive notification
    regions string[]
    List of regions
    resourceGroups string[]
    List of resource groups
    schedule string
    Recurring report schedule in RRULE format
    scheduleEnabled boolean
    (bool) Report scheduling enabled
    timeRanges GetReportTargetTimeRange[]
    (Required) The time range spec, as defined below.
    account_groups Sequence[str]
    List of cloud account groups
    accounts Sequence[str]
    List of cloud accounts
    compliance_standard_ids Sequence[str]
    List of compliance standard IDs
    compression_enabled bool
    (bool) Business unit detailed report compression enabled
    download_now bool
    (bool) True = download now
    notification_template_id str
    Notification template id
    notify_tos Sequence[str]
    List of email addresses to receive notification
    regions Sequence[str]
    List of regions
    resource_groups Sequence[str]
    List of resource groups
    schedule str
    Recurring report schedule in RRULE format
    schedule_enabled bool
    (bool) Report scheduling enabled
    time_ranges Sequence[GetReportTargetTimeRange]
    (Required) The time range spec, as defined below.
    accountGroups List<String>
    List of cloud account groups
    accounts List<String>
    List of cloud accounts
    complianceStandardIds List<String>
    List of compliance standard IDs
    compressionEnabled Boolean
    (bool) Business unit detailed report compression enabled
    downloadNow Boolean
    (bool) True = download now
    notificationTemplateId String
    Notification template id
    notifyTos List<String>
    List of email addresses to receive notification
    regions List<String>
    List of regions
    resourceGroups List<String>
    List of resource groups
    schedule String
    Recurring report schedule in RRULE format
    scheduleEnabled Boolean
    (bool) Report scheduling enabled
    timeRanges List<Property Map>
    (Required) The time range spec, as defined below.

    GetReportTargetTimeRange

    Absolutes List<GetReportTargetTimeRangeAbsolute>
    An absolute time range spec, as defined below
    Relatives List<GetReportTargetTimeRangeRelative>
    A relative time range spec, as defined below
    ToNows List<GetReportTargetTimeRangeToNow>
    A "To Now" time range spec, as defined below
    Absolutes []GetReportTargetTimeRangeAbsolute
    An absolute time range spec, as defined below
    Relatives []GetReportTargetTimeRangeRelative
    A relative time range spec, as defined below
    ToNows []GetReportTargetTimeRangeToNow
    A "To Now" time range spec, as defined below
    absolutes List<GetReportTargetTimeRangeAbsolute>
    An absolute time range spec, as defined below
    relatives List<GetReportTargetTimeRangeRelative>
    A relative time range spec, as defined below
    toNows List<GetReportTargetTimeRangeToNow>
    A "To Now" time range spec, as defined below
    absolutes GetReportTargetTimeRangeAbsolute[]
    An absolute time range spec, as defined below
    relatives GetReportTargetTimeRangeRelative[]
    A relative time range spec, as defined below
    toNows GetReportTargetTimeRangeToNow[]
    A "To Now" time range spec, as defined below
    absolutes Sequence[GetReportTargetTimeRangeAbsolute]
    An absolute time range spec, as defined below
    relatives Sequence[GetReportTargetTimeRangeRelative]
    A relative time range spec, as defined below
    to_nows Sequence[GetReportTargetTimeRangeToNow]
    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

    GetReportTargetTimeRangeAbsolute

    End double
    (int) End time
    Start double
    (int) Start time
    End float64
    (int) End time
    Start float64
    (int) Start time
    end Double
    (int) End time
    start Double
    (int) Start time
    end number
    (int) End time
    start number
    (int) Start time
    end float
    (int) End time
    start float
    (int) Start time
    end Number
    (int) End time
    start Number
    (int) Start time

    GetReportTargetTimeRangeRelative

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

    GetReportTargetTimeRangeToNow

    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