scm.getSecurityRuleList (v0)

Strata Cloud Manager v0.4.3 (0.x), Mar 9 26

Viewing docs for Strata Cloud Manager v0.4.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-scm

Viewing docs for Strata Cloud Manager v0.4.3 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

const pagedRulesList = scm.getSecurityRuleList({
    folder: "All",
    position: "pre",
});
export const fetchedRuleListSummary = {
    countOfRulesFetched: pagedRulesList.then(pagedRulesList => pagedRulesList.total),
    firstRuleName: pagedRulesList.then(pagedRulesList => pagedRulesList.datas?.[0]?.name),
};

import pulumi
import pulumi_scm as scm

paged_rules_list = scm.get_security_rule_list(folder="All",
    position="pre")
pulumi.export("fetchedRuleListSummary", {
    "countOfRulesFetched": paged_rules_list.total,
    "firstRuleName": paged_rules_list.datas[0].name,
})

package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pagedRulesList, err := scm.GetSecurityRuleList(ctx, &scm.GetSecurityRuleListArgs{
			Folder:   pulumi.StringRef("All"),
			Position: "pre",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("fetchedRuleListSummary", pulumi.Map{
			"countOfRulesFetched": pagedRulesList.Total,
			"firstRuleName":       pagedRulesList.Datas[0].Name,
		})
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var pagedRulesList = Scm.GetSecurityRuleList.Invoke(new()
    {
        Folder = "All",
        Position = "pre",
    });

    return new Dictionary<string, object?>
    {
        ["fetchedRuleListSummary"] = 
        {
            { "countOfRulesFetched", pagedRulesList.Apply(getSecurityRuleListResult => getSecurityRuleListResult.Total) },
            { "firstRuleName", pagedRulesList.Apply(getSecurityRuleListResult => getSecurityRuleListResult.Datas[0]?.Name) },
        },
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetSecurityRuleListArgs;
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 pagedRulesList = ScmFunctions.getSecurityRuleList(GetSecurityRuleListArgs.builder()
            .folder("All")
            .position("pre")
            .build());

        ctx.export("fetchedRuleListSummary", Map.ofEntries(
            Map.entry("countOfRulesFetched", pagedRulesList.total()),
            Map.entry("firstRuleName", pagedRulesList.datas()[0].name())
        ));
    }
}

variables:
  pagedRulesList:
    fn::invoke:
      function: scm:getSecurityRuleList
      arguments:
        folder: All
        position: pre
outputs:
  fetchedRuleListSummary:
    countOfRulesFetched: ${pagedRulesList.total}
    firstRuleName: ${pagedRulesList.datas[0].name}

Using getSecurityRuleList

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 getSecurityRuleList(args: GetSecurityRuleListArgs, opts?: InvokeOptions): Promise<GetSecurityRuleListResult>
function getSecurityRuleListOutput(args: GetSecurityRuleListOutputArgs, opts?: InvokeOptions): Output<GetSecurityRuleListResult>

def get_security_rule_list(device: Optional[str] = None,
                           folder: Optional[str] = None,
                           limit: Optional[int] = None,
                           name: Optional[str] = None,
                           offset: Optional[int] = None,
                           position: Optional[str] = None,
                           snippet: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSecurityRuleListResult
def get_security_rule_list_output(device: Optional[pulumi.Input[str]] = None,
                           folder: Optional[pulumi.Input[str]] = None,
                           limit: Optional[pulumi.Input[int]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           offset: Optional[pulumi.Input[int]] = None,
                           position: Optional[pulumi.Input[str]] = None,
                           snippet: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSecurityRuleListResult]

func GetSecurityRuleList(ctx *Context, args *GetSecurityRuleListArgs, opts ...InvokeOption) (*GetSecurityRuleListResult, error)
func GetSecurityRuleListOutput(ctx *Context, args *GetSecurityRuleListOutputArgs, opts ...InvokeOption) GetSecurityRuleListResultOutput

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

public static class GetSecurityRuleList 
{
    public static Task<GetSecurityRuleListResult> InvokeAsync(GetSecurityRuleListArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityRuleListResult> Invoke(GetSecurityRuleListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSecurityRuleListResult> getSecurityRuleList(GetSecurityRuleListArgs args, InvokeOptions options)
public static Output<GetSecurityRuleListResult> getSecurityRuleList(GetSecurityRuleListArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getSecurityRuleList:getSecurityRuleList
  arguments:
    # arguments dictionary

The following arguments are supported:

Position string: The position of a security rule
Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

Position string: The position of a security rule
Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

position String: The position of a security rule
device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Integer: The max number of items to return. Default: 200.
name String: The name of the item.
offset Integer: The offset of the first item to return.
snippet String: The snippet of the item.

position string: The position of a security rule
device string: The device of the item.
folder string: The folder of the item. Default: Shared.
limit number: The max number of items to return. Default: 200.
name string: The name of the item.
offset number: The offset of the first item to return.
snippet string: The snippet of the item.

position str: The position of a security rule
device str: The device of the item.
folder str: The folder of the item. Default: Shared.
limit int: The max number of items to return. Default: 200.
name str: The name of the item.
offset int: The offset of the first item to return.
snippet str: The snippet of the item.

position String: The position of a security rule
device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Number: The max number of items to return. Default: 200.
name String: The name of the item.
offset Number: The offset of the first item to return.
snippet String: The snippet of the item.

getSecurityRuleList Result

The following output properties are available:

Datas List<GetSecurityRuleListData>: The data.
Id string: The provider-assigned unique ID for this managed resource.
Position string: The position of a security rule
Tfid string
Total int: The total number of items.
Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

Datas []GetSecurityRuleListData: The data.
Id string: The provider-assigned unique ID for this managed resource.
Position string: The position of a security rule
Tfid string
Total int: The total number of items.
Device string: The device of the item.
Folder string: The folder of the item. Default: Shared.
Limit int: The max number of items to return. Default: 200.
Name string: The name of the item.
Offset int: The offset of the first item to return.
Snippet string: The snippet of the item.

datas List<GetSecurityRuleListData>: The data.
id String: The provider-assigned unique ID for this managed resource.
position String: The position of a security rule
tfid String
total Integer: The total number of items.
device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Integer: The max number of items to return. Default: 200.
name String: The name of the item.
offset Integer: The offset of the first item to return.
snippet String: The snippet of the item.

datas GetSecurityRuleListData[]: The data.
id string: The provider-assigned unique ID for this managed resource.
position string: The position of a security rule
tfid string
total number: The total number of items.
device string: The device of the item.
folder string: The folder of the item. Default: Shared.
limit number: The max number of items to return. Default: 200.
name string: The name of the item.
offset number: The offset of the first item to return.
snippet string: The snippet of the item.

datas Sequence[GetSecurityRuleListData]: The data.
id str: The provider-assigned unique ID for this managed resource.
position str: The position of a security rule
tfid str
total int: The total number of items.
device str: The device of the item.
folder str: The folder of the item. Default: Shared.
limit int: The max number of items to return. Default: 200.
name str: The name of the item.
offset int: The offset of the first item to return.
snippet str: The snippet of the item.

datas List<Property Map>: The data.
id String: The provider-assigned unique ID for this managed resource.
position String: The position of a security rule
tfid String
total Number: The total number of items.
device String: The device of the item.
folder String: The folder of the item. Default: Shared.
limit Number: The max number of items to return. Default: 200.
name String: The name of the item.
offset Number: The offset of the first item to return.
snippet String: The snippet of the item.

Supporting Types

GetSecurityRuleListData

Action string: The action to be taken when the rule is matched
AllowUrlCategories List<GetSecurityRuleListDataAllowUrlCategory>: Allow url category
AllowWebApplications List<GetSecurityRuleListDataAllowWebApplication>: Allow web application
Applications List<string>: The application(s) being accessed
BlockUrlCategories List<string>: Block url category
BlockWebApplications List<string>: Block web application
Categories List<string>: The URL categories being accessed
DefaultProfileSettings GetSecurityRuleListDataDefaultProfileSettings: Default profile settings
Description string: The description of the security rule
DestinationHips List<string>: The destination Host Integrity Profile(s)
Destinations List<string>: The destination address(es)
Device string: The device in which the resource is defined
Devices List<string>: Devices
Disabled bool: Is the security rule disabled?
Folder string: The folder in which the resource is defined
Froms List<string>: The source security zone(s)
Id string: The UUID of the security rule
LogEnd bool: Log at session end?
LogSetting string: The external log forwarding profile
LogSettings GetSecurityRuleListDataLogSettings: Log settings
LogStart bool: Log at session start?
Name string: The name of the security rule
NegateDestination bool: Negate the destination addresses(es)?
NegateSource bool: Negate the source address(es)?
NegateUser bool: Negate user
PolicyType string: Policy type
Position string: The position of a security rule
ProfileSetting GetSecurityRuleListDataProfileSetting: The security profile object
RelativePosition string: Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
Schedule string: Schedule in which this rule will be applied
SecuritySettings GetSecurityRuleListDataSecuritySettings: Security settings
Services List<string>: The service(s) being accessed
Snippet string: The snippet in which the resource is defined
SourceHips List<string>: The source Host Integrity Profile(s)
SourceUsers List<string>: List of source users and/or groups. Reserved words include any, pre-login, known-user, and unknown.
Sources List<string>: The source addresses(es)
Tags List<string>: The tags associated with the security rule
TargetRule string: The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
TenantRestrictions List<string>: Tenant restrictions
Tfid string
Tos List<string>: The destination security zone(s)

Action string: The action to be taken when the rule is matched
AllowUrlCategories []GetSecurityRuleListDataAllowUrlCategory: Allow url category
AllowWebApplications []GetSecurityRuleListDataAllowWebApplication: Allow web application
Applications []string: The application(s) being accessed
BlockUrlCategories []string: Block url category
BlockWebApplications []string: Block web application
Categories []string: The URL categories being accessed
DefaultProfileSettings GetSecurityRuleListDataDefaultProfileSettings: Default profile settings
Description string: The description of the security rule
DestinationHips []string: The destination Host Integrity Profile(s)
Destinations []string: The destination address(es)
Device string: The device in which the resource is defined
Devices []string: Devices
Disabled bool: Is the security rule disabled?
Folder string: The folder in which the resource is defined
Froms []string: The source security zone(s)
Id string: The UUID of the security rule
LogEnd bool: Log at session end?
LogSetting string: The external log forwarding profile
LogSettings GetSecurityRuleListDataLogSettings: Log settings
LogStart bool: Log at session start?
Name string: The name of the security rule
NegateDestination bool: Negate the destination addresses(es)?
NegateSource bool: Negate the source address(es)?
NegateUser bool: Negate user
PolicyType string: Policy type
Position string: The position of a security rule
ProfileSetting GetSecurityRuleListDataProfileSetting: The security profile object
RelativePosition string: Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
Schedule string: Schedule in which this rule will be applied
SecuritySettings GetSecurityRuleListDataSecuritySettings: Security settings
Services []string: The service(s) being accessed
Snippet string: The snippet in which the resource is defined
SourceHips []string: The source Host Integrity Profile(s)
SourceUsers []string: List of source users and/or groups. Reserved words include any, pre-login, known-user, and unknown.
Sources []string: The source addresses(es)
Tags []string: The tags associated with the security rule
TargetRule string: The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
TenantRestrictions []string: Tenant restrictions
Tfid string
Tos []string: The destination security zone(s)

action String: The action to be taken when the rule is matched
allowUrlCategories List<GetSecurityRuleListDataAllowUrlCategory>: Allow url category
allowWebApplications List<GetSecurityRuleListDataAllowWebApplication>: Allow web application
applications List<String>: The application(s) being accessed
blockUrlCategories List<String>: Block url category
blockWebApplications List<String>: Block web application
categories List<String>: The URL categories being accessed
defaultProfileSettings GetSecurityRuleListDataDefaultProfileSettings: Default profile settings
description String: The description of the security rule
destinationHips List<String>: The destination Host Integrity Profile(s)
destinations List<String>: The destination address(es)
device String: The device in which the resource is defined
devices List<String>: Devices
disabled Boolean: Is the security rule disabled?
folder String: The folder in which the resource is defined
froms List<String>: The source security zone(s)
id String: The UUID of the security rule
logEnd Boolean: Log at session end?
logSetting String: The external log forwarding profile
logSettings GetSecurityRuleListDataLogSettings: Log settings
logStart Boolean: Log at session start?
name String: The name of the security rule
negateDestination Boolean: Negate the destination addresses(es)?
negateSource Boolean: Negate the source address(es)?
negateUser Boolean: Negate user
policyType String: Policy type
position String: The position of a security rule
profileSetting GetSecurityRuleListDataProfileSetting: The security profile object
relativePosition String: Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
schedule String: Schedule in which this rule will be applied
securitySettings GetSecurityRuleListDataSecuritySettings: Security settings
services List<String>: The service(s) being accessed
snippet String: The snippet in which the resource is defined
sourceHips List<String>: The source Host Integrity Profile(s)
sourceUsers List<String>: List of source users and/or groups. Reserved words include any, pre-login, known-user, and unknown.
sources List<String>: The source addresses(es)
tags List<String>: The tags associated with the security rule
targetRule String: The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
tenantRestrictions List<String>: Tenant restrictions
tfid String
tos List<String>: The destination security zone(s)

action string: The action to be taken when the rule is matched
allowUrlCategories GetSecurityRuleListDataAllowUrlCategory[]: Allow url category
allowWebApplications GetSecurityRuleListDataAllowWebApplication[]: Allow web application
applications string[]: The application(s) being accessed
blockUrlCategories string[]: Block url category
blockWebApplications string[]: Block web application
categories string[]: The URL categories being accessed
defaultProfileSettings GetSecurityRuleListDataDefaultProfileSettings: Default profile settings
description string: The description of the security rule
destinationHips string[]: The destination Host Integrity Profile(s)
destinations string[]: The destination address(es)
device string: The device in which the resource is defined
devices string[]: Devices
disabled boolean: Is the security rule disabled?
folder string: The folder in which the resource is defined
froms string[]: The source security zone(s)
id string: The UUID of the security rule
logEnd boolean: Log at session end?
logSetting string: The external log forwarding profile
logSettings GetSecurityRuleListDataLogSettings: Log settings
logStart boolean: Log at session start?
name string: The name of the security rule
negateDestination boolean: Negate the destination addresses(es)?
negateSource boolean: Negate the source address(es)?
negateUser boolean: Negate user
policyType string: Policy type
position string: The position of a security rule
profileSetting GetSecurityRuleListDataProfileSetting: The security profile object
relativePosition string: Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
schedule string: Schedule in which this rule will be applied
securitySettings GetSecurityRuleListDataSecuritySettings: Security settings
services string[]: The service(s) being accessed
snippet string: The snippet in which the resource is defined
sourceHips string[]: The source Host Integrity Profile(s)
sourceUsers string[]: List of source users and/or groups. Reserved words include any, pre-login, known-user, and unknown.
sources string[]: The source addresses(es)
tags string[]: The tags associated with the security rule
targetRule string: The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
tenantRestrictions string[]: Tenant restrictions
tfid string
tos string[]: The destination security zone(s)

action str: The action to be taken when the rule is matched
allow_url_categories Sequence[GetSecurityRuleListDataAllowUrlCategory]: Allow url category
allow_web_applications Sequence[GetSecurityRuleListDataAllowWebApplication]: Allow web application
applications Sequence[str]: The application(s) being accessed
block_url_categories Sequence[str]: Block url category
block_web_applications Sequence[str]: Block web application
categories Sequence[str]: The URL categories being accessed
default_profile_settings GetSecurityRuleListDataDefaultProfileSettings: Default profile settings
description str: The description of the security rule
destination_hips Sequence[str]: The destination Host Integrity Profile(s)
destinations Sequence[str]: The destination address(es)
device str: The device in which the resource is defined
devices Sequence[str]: Devices
disabled bool: Is the security rule disabled?
folder str: The folder in which the resource is defined
froms Sequence[str]: The source security zone(s)
id str: The UUID of the security rule
log_end bool: Log at session end?
log_setting str: The external log forwarding profile
log_settings GetSecurityRuleListDataLogSettings: Log settings
log_start bool: Log at session start?
name str: The name of the security rule
negate_destination bool: Negate the destination addresses(es)?
negate_source bool: Negate the source address(es)?
negate_user bool: Negate user
policy_type str: Policy type
position str: The position of a security rule
profile_setting GetSecurityRuleListDataProfileSetting: The security profile object
relative_position str: Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
schedule str: Schedule in which this rule will be applied
security_settings GetSecurityRuleListDataSecuritySettings: Security settings
services Sequence[str]: The service(s) being accessed
snippet str: The snippet in which the resource is defined
source_hips Sequence[str]: The source Host Integrity Profile(s)
source_users Sequence[str]: List of source users and/or groups. Reserved words include any, pre-login, known-user, and unknown.
sources Sequence[str]: The source addresses(es)
tags Sequence[str]: The tags associated with the security rule
target_rule str: The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
tenant_restrictions Sequence[str]: Tenant restrictions
tfid str
tos Sequence[str]: The destination security zone(s)

action String: The action to be taken when the rule is matched
allowUrlCategories List<Property Map>: Allow url category
allowWebApplications List<Property Map>: Allow web application
applications List<String>: The application(s) being accessed
blockUrlCategories List<String>: Block url category
blockWebApplications List<String>: Block web application
categories List<String>: The URL categories being accessed
defaultProfileSettings Property Map: Default profile settings
description String: The description of the security rule
destinationHips List<String>: The destination Host Integrity Profile(s)
destinations List<String>: The destination address(es)
device String: The device in which the resource is defined
devices List<String>: Devices
disabled Boolean: Is the security rule disabled?
folder String: The folder in which the resource is defined
froms List<String>: The source security zone(s)
id String: The UUID of the security rule
logEnd Boolean: Log at session end?
logSetting String: The external log forwarding profile
logSettings Property Map: Log settings
logStart Boolean: Log at session start?
name String: The name of the security rule
negateDestination Boolean: Negate the destination addresses(es)?
negateSource Boolean: Negate the source address(es)?
negateUser Boolean: Negate user
policyType String: Policy type
position String: The position of a security rule
profileSetting Property Map: The security profile object
relativePosition String: Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
schedule String: Schedule in which this rule will be applied
securitySettings Property Map: Security settings
services List<String>: The service(s) being accessed
snippet String: The snippet in which the resource is defined
sourceHips List<String>: The source Host Integrity Profile(s)
sourceUsers List<String>: List of source users and/or groups. Reserved words include any, pre-login, known-user, and unknown.
sources List<String>: The source addresses(es)
tags List<String>: The tags associated with the security rule
targetRule String: The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
tenantRestrictions List<String>: Tenant restrictions
tfid String
tos List<String>: The destination security zone(s)