Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Strata Cloud Manager Provider
  4. API Docs
  5. getPbfRule
Viewing docs for Strata Cloud Manager v1.2.1
published on Friday, Oct 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

scm.getPbfRule

scm logo Strata Cloud Manager
Viewing docs for Strata Cloud Manager v1.2.1
published on Friday, Oct 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

    PbfRule data source

    Example Usage

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

// Define the function (the item to be retrieved via API GET)
const pbfExternalWebTestGet = scm.getPbfRule({
    id: "044d67ad-1c36-4b97-bbf4-584445fe8a7d",
});
export const retrievedIDAndName = {
    id: pbfExternalWebTestGet.then(pbfExternalWebTestGet => pbfExternalWebTestGet.id),
    name: pbfExternalWebTestGet.then(pbfExternalWebTestGet => pbfExternalWebTestGet.name),
};
export const recievedResponse = pbfExternalWebTestGet;

    import pulumi
import pulumi_scm as scm

# Define the function (the item to be retrieved via API GET)
pbf_external_web_test_get = scm.get_pbf_rule(id="044d67ad-1c36-4b97-bbf4-584445fe8a7d")
pulumi.export("retrievedIDAndName", {
    "id": pbf_external_web_test_get.id,
    "name": pbf_external_web_test_get.name,
})
pulumi.export("recievedResponse", pbf_external_web_test_get)

    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 {
		// Define the function (the item to be retrieved via API GET)
		pbfExternalWebTestGet, err := scm.GetPbfRule(ctx, &scm.LookupPbfRuleArgs{
			Id: "044d67ad-1c36-4b97-bbf4-584445fe8a7d",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("retrievedIDAndName", pulumi.StringMap{
			"id":   pbfExternalWebTestGet.Id,
			"name": pbfExternalWebTestGet.Name,
		})
		ctx.Export("recievedResponse", pbfExternalWebTestGet)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Define the function (the item to be retrieved via API GET)
    var pbfExternalWebTestGet = Scm.GetPbfRule.Invoke(new()
    {
        Id = "044d67ad-1c36-4b97-bbf4-584445fe8a7d",
    });

    return new Dictionary<string, object?>
    {
        ["retrievedIDAndName"] = new Dictionary<string, object?>
        {
            ["id"] = pbfExternalWebTestGet.Apply(getPbfRuleResult => getPbfRuleResult.Id),
            ["name"] = pbfExternalWebTestGet.Apply(getPbfRuleResult => getPbfRuleResult.Name),
        },
        ["recievedResponse"] = pbfExternalWebTestGet,
    };
});

    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.GetPbfRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        // Define the function (the item to be retrieved via API GET)
        final var pbfExternalWebTestGet = ScmFunctions.getPbfRule(GetPbfRuleArgs.builder()
            .id("044d67ad-1c36-4b97-bbf4-584445fe8a7d")
            .build());

        ctx.export("retrievedIDAndName", Map.ofEntries(
            Map.entry("id", pbfExternalWebTestGet.id()),
            Map.entry("name", pbfExternalWebTestGet.name())
        ));
        ctx.export("recievedResponse", pbfExternalWebTestGet);
    }
}

    variables:
  # Define the function (the item to be retrieved via API GET)
  pbfExternalWebTestGet:
    fn::invoke:
      function: scm:getPbfRule
      arguments:
        id: 044d67ad-1c36-4b97-bbf4-584445fe8a7d
outputs:
  # --- Output Blocks to Print Retrieved Data ---
  retrievedIDAndName:
    id: ${pbfExternalWebTestGet.id}
    name: ${pbfExternalWebTestGet.name}
  recievedResponse: ${pbfExternalWebTestGet}

    terraform {
  required_providers {
    scm = {
      source = "pulumi/scm"
    }
  }
}

data "scm_pbf_rule" "pbfExternalWebTestGet" {
  id = "044d67ad-1c36-4b97-bbf4-584445fe8a7d"
}

# Define the function (the item to be retrieved via API GET)
# The function needs the unique ID generated by the resource creation
# --- Output Blocks to Print Retrieved Data ---
output "retrievedIDAndName" {
  value = {
    "id"   = data.scm_pbf_rule.pbfExternalWebTestGet.id
    "name" = data.scm_pbf_rule.pbfExternalWebTestGet.name
  }
}
output "recievedResponse" {
  value = data.scm_pbf_rule.pbfExternalWebTestGet
}

    Using getPbfRule

    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 getPbfRule(args: GetPbfRuleArgs, opts?: InvokeOptions): Promise<GetPbfRuleResult>
function getPbfRuleOutput(args: GetPbfRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetPbfRuleResult>
    def get_pbf_rule(device: Optional[str] = None,
                 folder: Optional[str] = None,
                 id: Optional[str] = None,
                 name: Optional[str] = None,
                 snippet: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPbfRuleResult
def get_pbf_rule_output(device: pulumi.Input[Optional[str]] = None,
                 folder: pulumi.Input[Optional[str]] = None,
                 id: pulumi.Input[Optional[str]] = None,
                 name: pulumi.Input[Optional[str]] = None,
                 snippet: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetPbfRuleResult]
    func LookupPbfRule(ctx *Context, args *LookupPbfRuleArgs, opts ...InvokeOption) (*LookupPbfRuleResult, error)
func LookupPbfRuleOutput(ctx *Context, args *LookupPbfRuleOutputArgs, opts ...InvokeOption) LookupPbfRuleResultOutput

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

    public static class GetPbfRule 
{
    public static Task<GetPbfRuleResult> InvokeAsync(GetPbfRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetPbfRuleResult> Invoke(GetPbfRuleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPbfRuleResult> Invoke(GetPbfRuleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPbfRuleResult> getPbfRule(GetPbfRuleArgs args, InvokeOptions options)
public static Output<GetPbfRuleResult> getPbfRule(GetPbfRuleArgs args, InvokeOptions options)
public static Output<GetPbfRuleResult> getPbfRule(GetPbfRuleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: scm:index/getPbfRule:getPbfRule
  arguments:
    # arguments dictionary
    data "scm_get_pbf_rule" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    UUID of the resource
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Name string
    PBF rule name
    Snippet string
    The snippet in which the resource is defined
    Id string
    UUID of the resource
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Name string
    PBF rule name
    Snippet string
    The snippet in which the resource is defined
    id string
    UUID of the resource
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    name string
    PBF rule name
    snippet string
    The snippet in which the resource is defined
    id String
    UUID of the resource
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    name String
    PBF rule name
    snippet String
    The snippet in which the resource is defined
    id string
    UUID of the resource
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    name string
    PBF rule name
    snippet string
    The snippet in which the resource is defined
    id str
    UUID of the resource
    device str
    The device in which the resource is defined
    folder str
    The folder in which the resource is defined
    name str
    PBF rule name
    snippet str
    The snippet in which the resource is defined
    id String
    UUID of the resource
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    name String
    PBF rule name
    snippet String
    The snippet in which the resource is defined

    getPbfRule Result

    The following output properties are available:

    Action GetPbfRuleAction
    Action
    Applications List<string>
    Applications
    Description string
    Description
    Destinations List<string>
    Destination addresses
    Device string
    The device in which the resource is defined
    EnforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
    Enforce symmetric return
    Folder string
    The folder in which the resource is defined
    From GetPbfRuleFrom
    From
    Id string
    UUID of the resource
    Name string
    PBF rule name
    NegateDestination bool
    Negate destination address
    NegateSource bool
    Negate source address
    Schedule string
    Schedule
    Services List<string>
    Services
    Snippet string
    The snippet in which the resource is defined
    SourceUsers List<string>
    Source users
    Sources List<string>
    Source addresses
    Tags List<string>
    Tags
    Tfid string
    The Terraform ID.
    Action GetPbfRuleAction
    Action
    Applications []string
    Applications
    Description string
    Description
    Destinations []string
    Destination addresses
    Device string
    The device in which the resource is defined
    EnforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
    Enforce symmetric return
    Folder string
    The folder in which the resource is defined
    From GetPbfRuleFrom
    From
    Id string
    UUID of the resource
    Name string
    PBF rule name
    NegateDestination bool
    Negate destination address
    NegateSource bool
    Negate source address
    Schedule string
    Schedule
    Services []string
    Services
    Snippet string
    The snippet in which the resource is defined
    SourceUsers []string
    Source users
    Sources []string
    Source addresses
    Tags []string
    Tags
    Tfid string
    The Terraform ID.
    action object
    Action
    applications list(string)
    Applications
    description string
    Description
    destinations list(string)
    Destination addresses
    device string
    The device in which the resource is defined
    enforce_symmetric_return object
    Enforce symmetric return
    folder string
    The folder in which the resource is defined
    from object
    From
    id string
    UUID of the resource
    name string
    PBF rule name
    negate_destination bool
    Negate destination address
    negate_source bool
    Negate source address
    schedule string
    Schedule
    services list(string)
    Services
    snippet string
    The snippet in which the resource is defined
    source_users list(string)
    Source users
    sources list(string)
    Source addresses
    tags list(string)
    Tags
    tfid string
    The Terraform ID.
    action GetPbfRuleAction
    Action
    applications List<String>
    Applications
    description String
    Description
    destinations List<String>
    Destination addresses
    device String
    The device in which the resource is defined
    enforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
    Enforce symmetric return
    folder String
    The folder in which the resource is defined
    from GetPbfRuleFrom
    From
    id String
    UUID of the resource
    name String
    PBF rule name
    negateDestination Boolean
    Negate destination address
    negateSource Boolean
    Negate source address
    schedule String
    Schedule
    services List<String>
    Services
    snippet String
    The snippet in which the resource is defined
    sourceUsers List<String>
    Source users
    sources List<String>
    Source addresses
    tags List<String>
    Tags
    tfid String
    The Terraform ID.
    action GetPbfRuleAction
    Action
    applications string[]
    Applications
    description string
    Description
    destinations string[]
    Destination addresses
    device string
    The device in which the resource is defined
    enforceSymmetricReturn GetPbfRuleEnforceSymmetricReturn
    Enforce symmetric return
    folder string
    The folder in which the resource is defined
    from GetPbfRuleFrom
    From
    id string
    UUID of the resource
    name string
    PBF rule name
    negateDestination boolean
    Negate destination address
    negateSource boolean
    Negate source address
    schedule string
    Schedule
    services string[]
    Services
    snippet string
    The snippet in which the resource is defined
    sourceUsers string[]
    Source users
    sources string[]
    Source addresses
    tags string[]
    Tags
    tfid string
    The Terraform ID.
    action GetPbfRuleAction
    Action
    applications Sequence[str]
    Applications
    description str
    Description
    destinations Sequence[str]
    Destination addresses
    device str
    The device in which the resource is defined
    enforce_symmetric_return GetPbfRuleEnforceSymmetricReturn
    Enforce symmetric return
    folder str
    The folder in which the resource is defined
    from_ GetPbfRuleFrom
    From
    id str
    UUID of the resource
    name str
    PBF rule name
    negate_destination bool
    Negate destination address
    negate_source bool
    Negate source address
    schedule str
    Schedule
    services Sequence[str]
    Services
    snippet str
    The snippet in which the resource is defined
    source_users Sequence[str]
    Source users
    sources Sequence[str]
    Source addresses
    tags Sequence[str]
    Tags
    tfid str
    The Terraform ID.
    action Property Map
    Action
    applications List<String>
    Applications
    description String
    Description
    destinations List<String>
    Destination addresses
    device String
    The device in which the resource is defined
    enforceSymmetricReturn Property Map
    Enforce symmetric return
    folder String
    The folder in which the resource is defined
    from Property Map
    From
    id String
    UUID of the resource
    name String
    PBF rule name
    negateDestination Boolean
    Negate destination address
    negateSource Boolean
    Negate source address
    schedule String
    Schedule
    services List<String>
    Services
    snippet String
    The snippet in which the resource is defined
    sourceUsers List<String>
    Source users
    sources List<String>
    Source addresses
    tags List<String>
    Tags
    tfid String
    The Terraform ID.

    Supporting Types

    GetPbfRuleAction

    GetPbfRuleActionForward

    egress_interface string
    Egress interface
    monitor object
    Monitor
    nexthop object
    Nexthop
    egressInterface String
    Egress interface
    monitor Property Map
    Monitor
    nexthop Property Map
    Nexthop

    GetPbfRuleActionForwardMonitor

    DisableIfUnreachable bool
    Disable this rule if nexthop/monitor ip is unreachable?
    IpAddress string
    Monitor IP address
    Profile string
    Monitoring profile
    DisableIfUnreachable bool
    Disable this rule if nexthop/monitor ip is unreachable?
    IpAddress string
    Monitor IP address
    Profile string
    Monitoring profile
    disable_if_unreachable bool
    Disable this rule if nexthop/monitor ip is unreachable?
    ip_address string
    Monitor IP address
    profile string
    Monitoring profile
    disableIfUnreachable Boolean
    Disable this rule if nexthop/monitor ip is unreachable?
    ipAddress String
    Monitor IP address
    profile String
    Monitoring profile
    disableIfUnreachable boolean
    Disable this rule if nexthop/monitor ip is unreachable?
    ipAddress string
    Monitor IP address
    profile string
    Monitoring profile
    disable_if_unreachable bool
    Disable this rule if nexthop/monitor ip is unreachable?
    ip_address str
    Monitor IP address
    profile str
    Monitoring profile
    disableIfUnreachable Boolean
    Disable this rule if nexthop/monitor ip is unreachable?
    ipAddress String
    Monitor IP address
    profile String
    Monitoring profile

    GetPbfRuleActionForwardNexthop

    Fqdn string
    Next hop FQDN
    IpAddress string
    Next hop IP address
    Fqdn string
    Next hop FQDN
    IpAddress string
    Next hop IP address
    fqdn string
    Next hop FQDN
    ip_address string
    Next hop IP address
    fqdn String
    Next hop FQDN
    ipAddress String
    Next hop IP address
    fqdn string
    Next hop FQDN
    ipAddress string
    Next hop IP address
    fqdn str
    Next hop FQDN
    ip_address str
    Next hop IP address
    fqdn String
    Next hop FQDN
    ipAddress String
    Next hop IP address

    GetPbfRuleEnforceSymmetricReturn

    Enabled bool
    Enforce symmetric return?
    NexthopAddressLists []GetPbfRuleEnforceSymmetricReturnNexthopAddressList
    Next hop IP addresses
    enabled bool
    Enforce symmetric return?
    nexthop_address_lists list(object)
    Next hop IP addresses
    enabled Boolean
    Enforce symmetric return?
    nexthopAddressLists List<GetPbfRuleEnforceSymmetricReturnNexthopAddressList>
    Next hop IP addresses
    enabled boolean
    Enforce symmetric return?
    nexthopAddressLists GetPbfRuleEnforceSymmetricReturnNexthopAddressList[]
    Next hop IP addresses
    enabled Boolean
    Enforce symmetric return?
    nexthopAddressLists List<Property Map>
    Next hop IP addresses

    GetPbfRuleEnforceSymmetricReturnNexthopAddressList

    Name string
    Next hop IP address
    Name string
    Next hop IP address
    name string
    Next hop IP address
    name String
    Next hop IP address
    name string
    Next hop IP address
    name str
    Next hop IP address
    name String
    Next hop IP address

    GetPbfRuleFrom

    Interfaces List<string>
    Source interfaces
    Zones List<string>
    Source zones
    Interfaces []string
    Source interfaces
    Zones []string
    Source zones
    interfaces list(string)
    Source interfaces
    zones list(string)
    Source zones
    interfaces List<String>
    Source interfaces
    zones List<String>
    Source zones
    interfaces string[]
    Source interfaces
    zones string[]
    Source zones
    interfaces Sequence[str]
    Source interfaces
    zones Sequence[str]
    Source zones
    interfaces List<String>
    Source interfaces
    zones List<String>
    Source zones

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo Strata Cloud Manager
    Viewing docs for Strata Cloud Manager v1.2.1
    published on Friday, Oct 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-scm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial