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

prismacloud.getAlertRules

Explore with Pulumi AI

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

Retrieve a list of alert rules.

Example Usage

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

const example = prismacloud.getAlertRules({});
Copy
import pulumi
import pulumi_prismacloud as prismacloud

example = prismacloud.get_alert_rules()
Copy
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.GetAlertRules(ctx, &prismacloud.GetAlertRulesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prismacloud = Pulumi.Prismacloud;

return await Deployment.RunAsync(() => 
{
    var example = Prismacloud.GetAlertRules.Invoke();

});
Copy
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.GetAlertRulesArgs;
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.getAlertRules();

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: prismacloud:getAlertRules
      arguments: {}
Copy

Using getAlertRules

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 getAlertRules(args: GetAlertRulesArgs, opts?: InvokeOptions): Promise<GetAlertRulesResult>
function getAlertRulesOutput(args: GetAlertRulesOutputArgs, opts?: InvokeOptions): Output<GetAlertRulesResult>
Copy
def get_alert_rules(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAlertRulesResult
def get_alert_rules_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAlertRulesResult]
Copy
func GetAlertRules(ctx *Context, args *GetAlertRulesArgs, opts ...InvokeOption) (*GetAlertRulesResult, error)
func GetAlertRulesOutput(ctx *Context, args *GetAlertRulesOutputArgs, opts ...InvokeOption) GetAlertRulesResultOutput
Copy

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

public static class GetAlertRules 
{
    public static Task<GetAlertRulesResult> InvokeAsync(GetAlertRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertRulesResult> Invoke(GetAlertRulesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAlertRulesResult> getAlertRules(GetAlertRulesArgs args, InvokeOptions options)
public static Output<GetAlertRulesResult> getAlertRules(GetAlertRulesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: prismacloud:index/getAlertRules:getAlertRules
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Id string
id String
id string
id str
id String

getAlertRules Result

The following output properties are available:

Id string
Listings List<GetAlertRulesListing>
List of alerts returned, as defined below.
Total double
(int) Total number of alert rules.
Id string
Listings []GetAlertRulesListing
List of alerts returned, as defined below.
Total float64
(int) Total number of alert rules.
id String
listings List<GetAlertRulesListing>
List of alerts returned, as defined below.
total Double
(int) Total number of alert rules.
id string
listings GetAlertRulesListing[]
List of alerts returned, as defined below.
total number
(int) Total number of alert rules.
id str
listings Sequence[GetAlertRulesListing]
List of alerts returned, as defined below.
total float
(int) Total number of alert rules.
id String
listings List<Property Map>
List of alerts returned, as defined below.
total Number
(int) Total number of alert rules.

Supporting Types

GetAlertRulesListing

Deleted This property is required. bool
(bool) Deleted
Description This property is required. string
Description
Enabled This property is required. bool
(bool) Rule/Scan is enabled or not
Name This property is required. string
Rule/Scan name
OpenAlertsCount This property is required. double
(int) Open alerts count
Owner This property is required. string
Customer
Policies This property is required. List<string>
List of specific policies to scan
PolicyScanConfigId This property is required. string
Policy scan config ID
ReadOnly This property is required. bool
(bool) Model is read-only
ScanAll This property is required. bool
(bool) Scan all policies
Deleted This property is required. bool
(bool) Deleted
Description This property is required. string
Description
Enabled This property is required. bool
(bool) Rule/Scan is enabled or not
Name This property is required. string
Rule/Scan name
OpenAlertsCount This property is required. float64
(int) Open alerts count
Owner This property is required. string
Customer
Policies This property is required. []string
List of specific policies to scan
PolicyScanConfigId This property is required. string
Policy scan config ID
ReadOnly This property is required. bool
(bool) Model is read-only
ScanAll This property is required. bool
(bool) Scan all policies
deleted This property is required. Boolean
(bool) Deleted
description This property is required. String
Description
enabled This property is required. Boolean
(bool) Rule/Scan is enabled or not
name This property is required. String
Rule/Scan name
openAlertsCount This property is required. Double
(int) Open alerts count
owner This property is required. String
Customer
policies This property is required. List<String>
List of specific policies to scan
policyScanConfigId This property is required. String
Policy scan config ID
readOnly This property is required. Boolean
(bool) Model is read-only
scanAll This property is required. Boolean
(bool) Scan all policies
deleted This property is required. boolean
(bool) Deleted
description This property is required. string
Description
enabled This property is required. boolean
(bool) Rule/Scan is enabled or not
name This property is required. string
Rule/Scan name
openAlertsCount This property is required. number
(int) Open alerts count
owner This property is required. string
Customer
policies This property is required. string[]
List of specific policies to scan
policyScanConfigId This property is required. string
Policy scan config ID
readOnly This property is required. boolean
(bool) Model is read-only
scanAll This property is required. boolean
(bool) Scan all policies
deleted This property is required. bool
(bool) Deleted
description This property is required. str
Description
enabled This property is required. bool
(bool) Rule/Scan is enabled or not
name This property is required. str
Rule/Scan name
open_alerts_count This property is required. float
(int) Open alerts count
owner This property is required. str
Customer
policies This property is required. Sequence[str]
List of specific policies to scan
policy_scan_config_id This property is required. str
Policy scan config ID
read_only This property is required. bool
(bool) Model is read-only
scan_all This property is required. bool
(bool) Scan all policies
deleted This property is required. Boolean
(bool) Deleted
description This property is required. String
Description
enabled This property is required. Boolean
(bool) Rule/Scan is enabled or not
name This property is required. String
Rule/Scan name
openAlertsCount This property is required. Number
(int) Open alerts count
owner This property is required. String
Customer
policies This property is required. List<String>
List of specific policies to scan
policyScanConfigId This property is required. String
Policy scan config ID
readOnly This property is required. Boolean
(bool) Model is read-only
scanAll This property is required. Boolean
(bool) Scan all policies

Package Details

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