1. Packages
  2. Panos Provider
  3. API Docs
  4. DataFilteringProfile
Viewing docs for panos 2.0.10
published on Thursday, Apr 9, 2026 by paloaltonetworks
Schema (JSON)
paloaltonetworks/terraform-provider-panos

panos.DataFilteringProfile

Viewing docs for panos 2.0.10
published on Thursday, Apr 9, 2026 by paloaltonetworks
Schema (JSON)
paloaltonetworks/terraform-provider-panos

    Example Usage

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

const example = new panos.DeviceGroup("example", {
    location: {
        panorama: {},
    },
    name: "my-device-group",
});
const exampleCustomDataObject = new panos.CustomDataObject("example", {
    location: {
        deviceGroup: example.name,
    },
    name: "my-custom-data-object",
    description: "test custom data object",
    patternType: {
        regex: {
            patterns: [{
                name: "pattern1",
                regex: "test-regex",
            }],
        },
    },
});
const exampleDataFilteringProfile = new panos.DataFilteringProfile("example", {
    location: {
        deviceGroup: example.name,
    },
    name: "my-data-filtering-profile",
    dataCapture: true,
    description: "test description",
    disableOverride: "yes",
    rules: [{
        name: "rule1",
        dataObject: exampleCustomDataObject.name,
        direction: "both",
        alertThreshold: 10,
        blockThreshold: 20,
        logSeverity: "high",
        applications: ["any"],
        fileTypes: ["any"],
    }],
});

    import pulumi
import pulumi_panos as panos

example = panos.DeviceGroup("example",
    location={
        "panorama": {},
    },
    name="my-device-group")
example_custom_data_object = panos.CustomDataObject("example",
    location={
        "device_group": example.name,
    },
    name="my-custom-data-object",
    description="test custom data object",
    pattern_type={
        "regex": {
            "patterns": [{
                "name": "pattern1",
                "regex": "test-regex",
            }],
        },
    })
example_data_filtering_profile = panos.DataFilteringProfile("example",
    location={
        "device_group": example.name,
    },
    name="my-data-filtering-profile",
    data_capture=True,
    description="test description",
    disable_override="yes",
    rules=[{
        "name": "rule1",
        "data_object": example_custom_data_object.name,
        "direction": "both",
        "alert_threshold": 10,
        "block_threshold": 20,
        "log_severity": "high",
        "applications": ["any"],
        "file_types": ["any"],
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/panos/v2/panos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := panos.NewDeviceGroup(ctx, "example", &panos.DeviceGroupArgs{
			Location: &panos.DeviceGroupLocationArgs{
				Panorama: &panos.DeviceGroupLocationPanoramaArgs{},
			},
			Name: pulumi.String("my-device-group"),
		})
		if err != nil {
			return err
		}
		exampleCustomDataObject, err := panos.NewCustomDataObject(ctx, "example", &panos.CustomDataObjectArgs{
			Location: &panos.CustomDataObjectLocationArgs{
				DeviceGroup: example.Name,
			},
			Name:        pulumi.String("my-custom-data-object"),
			Description: pulumi.String("test custom data object"),
			PatternType: &panos.CustomDataObjectPatternTypeArgs{
				Regex: &panos.CustomDataObjectPatternTypeRegexArgs{
					Patterns: panos.CustomDataObjectPatternTypeRegexPatternArray{
						&panos.CustomDataObjectPatternTypeRegexPatternArgs{
							Name:  pulumi.String("pattern1"),
							Regex: pulumi.String("test-regex"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = panos.NewDataFilteringProfile(ctx, "example", &panos.DataFilteringProfileArgs{
			Location: &panos.DataFilteringProfileLocationArgs{
				DeviceGroup: example.Name,
			},
			Name:            pulumi.String("my-data-filtering-profile"),
			DataCapture:     pulumi.Bool(true),
			Description:     pulumi.String("test description"),
			DisableOverride: pulumi.String("yes"),
			Rules: panos.DataFilteringProfileRuleArray{
				&panos.DataFilteringProfileRuleArgs{
					Name:           pulumi.String("rule1"),
					DataObject:     exampleCustomDataObject.Name,
					Direction:      pulumi.String("both"),
					AlertThreshold: pulumi.Float64(10),
					BlockThreshold: pulumi.Float64(20),
					LogSeverity:    pulumi.String("high"),
					Applications: pulumi.StringArray{
						pulumi.String("any"),
					},
					FileTypes: pulumi.StringArray{
						pulumi.String("any"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Panos.DeviceGroup("example", new()
    {
        Location = new Panos.Inputs.DeviceGroupLocationArgs
        {
            Panorama = null,
        },
        Name = "my-device-group",
    });

    var exampleCustomDataObject = new Panos.CustomDataObject("example", new()
    {
        Location = new Panos.Inputs.CustomDataObjectLocationArgs
        {
            DeviceGroup = example.Name,
        },
        Name = "my-custom-data-object",
        Description = "test custom data object",
        PatternType = new Panos.Inputs.CustomDataObjectPatternTypeArgs
        {
            Regex = new Panos.Inputs.CustomDataObjectPatternTypeRegexArgs
            {
                Patterns = new[]
                {
                    new Panos.Inputs.CustomDataObjectPatternTypeRegexPatternArgs
                    {
                        Name = "pattern1",
                        Regex = "test-regex",
                    },
                },
            },
        },
    });

    var exampleDataFilteringProfile = new Panos.DataFilteringProfile("example", new()
    {
        Location = new Panos.Inputs.DataFilteringProfileLocationArgs
        {
            DeviceGroup = example.Name,
        },
        Name = "my-data-filtering-profile",
        DataCapture = true,
        Description = "test description",
        DisableOverride = "yes",
        Rules = new[]
        {
            new Panos.Inputs.DataFilteringProfileRuleArgs
            {
                Name = "rule1",
                DataObject = exampleCustomDataObject.Name,
                Direction = "both",
                AlertThreshold = 10,
                BlockThreshold = 20,
                LogSeverity = "high",
                Applications = new[]
                {
                    "any",
                },
                FileTypes = new[]
                {
                    "any",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.panos.DeviceGroup;
import com.pulumi.panos.DeviceGroupArgs;
import com.pulumi.panos.inputs.DeviceGroupLocationArgs;
import com.pulumi.panos.inputs.DeviceGroupLocationPanoramaArgs;
import com.pulumi.panos.CustomDataObject;
import com.pulumi.panos.CustomDataObjectArgs;
import com.pulumi.panos.inputs.CustomDataObjectLocationArgs;
import com.pulumi.panos.inputs.CustomDataObjectPatternTypeArgs;
import com.pulumi.panos.inputs.CustomDataObjectPatternTypeRegexArgs;
import com.pulumi.panos.DataFilteringProfile;
import com.pulumi.panos.DataFilteringProfileArgs;
import com.pulumi.panos.inputs.DataFilteringProfileLocationArgs;
import com.pulumi.panos.inputs.DataFilteringProfileRuleArgs;
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) {
        var example = new DeviceGroup("example", DeviceGroupArgs.builder()
            .location(DeviceGroupLocationArgs.builder()
                .panorama(DeviceGroupLocationPanoramaArgs.builder()
                    .build())
                .build())
            .name("my-device-group")
            .build());

        var exampleCustomDataObject = new CustomDataObject("exampleCustomDataObject", CustomDataObjectArgs.builder()
            .location(CustomDataObjectLocationArgs.builder()
                .deviceGroup(example.name())
                .build())
            .name("my-custom-data-object")
            .description("test custom data object")
            .patternType(CustomDataObjectPatternTypeArgs.builder()
                .regex(CustomDataObjectPatternTypeRegexArgs.builder()
                    .patterns(CustomDataObjectPatternTypeRegexPatternArgs.builder()
                        .name("pattern1")
                        .regex("test-regex")
                        .build())
                    .build())
                .build())
            .build());

        var exampleDataFilteringProfile = new DataFilteringProfile("exampleDataFilteringProfile", DataFilteringProfileArgs.builder()
            .location(DataFilteringProfileLocationArgs.builder()
                .deviceGroup(example.name())
                .build())
            .name("my-data-filtering-profile")
            .dataCapture(true)
            .description("test description")
            .disableOverride("yes")
            .rules(DataFilteringProfileRuleArgs.builder()
                .name("rule1")
                .dataObject(exampleCustomDataObject.name())
                .direction("both")
                .alertThreshold(10.0)
                .blockThreshold(20.0)
                .logSeverity("high")
                .applications("any")
                .fileTypes("any")
                .build())
            .build());

    }
}

    resources:
  example:
    type: panos:DeviceGroup
    properties:
      location:
        panorama: {}
      name: my-device-group
  exampleCustomDataObject:
    type: panos:CustomDataObject
    name: example
    properties:
      location:
        deviceGroup: ${example.name}
      name: my-custom-data-object
      description: test custom data object
      patternType:
        regex:
          patterns:
            - name: pattern1
              regex: test-regex
  exampleDataFilteringProfile:
    type: panos:DataFilteringProfile
    name: example
    properties:
      location:
        deviceGroup: ${example.name}
      name: my-data-filtering-profile
      dataCapture: true
      description: test description
      disableOverride: yes
      rules:
        - name: rule1
          dataObject: ${exampleCustomDataObject.name}
          direction: both
          alertThreshold: 10
          blockThreshold: 20
          logSeverity: high
          applications:
            - any
          fileTypes:
            - any

    Create DataFilteringProfile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataFilteringProfile(name: string, args: DataFilteringProfileArgs, opts?: CustomResourceOptions);
    @overload
def DataFilteringProfile(resource_name: str,
                         args: DataFilteringProfileArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DataFilteringProfile(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         location: Optional[DataFilteringProfileLocationArgs] = None,
                         data_capture: Optional[bool] = None,
                         description: Optional[str] = None,
                         disable_override: Optional[str] = None,
                         name: Optional[str] = None,
                         rules: Optional[Sequence[DataFilteringProfileRuleArgs]] = None)
    func NewDataFilteringProfile(ctx *Context, name string, args DataFilteringProfileArgs, opts ...ResourceOption) (*DataFilteringProfile, error)
    public DataFilteringProfile(string name, DataFilteringProfileArgs args, CustomResourceOptions? opts = null)
    public DataFilteringProfile(String name, DataFilteringProfileArgs args)
public DataFilteringProfile(String name, DataFilteringProfileArgs args, CustomResourceOptions options)

    type: panos:DataFilteringProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DataFilteringProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataFilteringProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataFilteringProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataFilteringProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataFilteringProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dataFilteringProfileResource = new Panos.Index.DataFilteringProfile("dataFilteringProfileResource", new()
{
    Location = new Panos.Inputs.DataFilteringProfileLocationArgs
    {
        DeviceGroup = new Panos.Inputs.DataFilteringProfileLocationDeviceGroupArgs
        {
            Name = "string",
            PanoramaDevice = "string",
        },
        Shared = null,
    },
    DataCapture = false,
    Description = "string",
    DisableOverride = "string",
    Name = "string",
    Rules = new[]
    {
        new Panos.Inputs.DataFilteringProfileRuleArgs
        {
            Name = "string",
            AlertThreshold = 0,
            Applications = new[]
            {
                "string",
            },
            BlockThreshold = 0,
            DataObject = "string",
            Direction = "string",
            FileTypes = new[]
            {
                "string",
            },
            LogSeverity = "string",
        },
    },
});

    example, err := panos.NewDataFilteringProfile(ctx, "dataFilteringProfileResource", &panos.DataFilteringProfileArgs{
	Location: &panos.DataFilteringProfileLocationArgs{
		DeviceGroup: &panos.DataFilteringProfileLocationDeviceGroupArgs{
			Name:           pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
		},
		Shared: &panos.DataFilteringProfileLocationSharedArgs{},
	},
	DataCapture:     pulumi.Bool(false),
	Description:     pulumi.String("string"),
	DisableOverride: pulumi.String("string"),
	Name:            pulumi.String("string"),
	Rules: panos.DataFilteringProfileRuleArray{
		&panos.DataFilteringProfileRuleArgs{
			Name:           pulumi.String("string"),
			AlertThreshold: pulumi.Float64(0),
			Applications: pulumi.StringArray{
				pulumi.String("string"),
			},
			BlockThreshold: pulumi.Float64(0),
			DataObject:     pulumi.String("string"),
			Direction:      pulumi.String("string"),
			FileTypes: pulumi.StringArray{
				pulumi.String("string"),
			},
			LogSeverity: pulumi.String("string"),
		},
	},
})

    var dataFilteringProfileResource = new DataFilteringProfile("dataFilteringProfileResource", DataFilteringProfileArgs.builder()
    .location(DataFilteringProfileLocationArgs.builder()
        .deviceGroup(DataFilteringProfileLocationDeviceGroupArgs.builder()
            .name("string")
            .panoramaDevice("string")
            .build())
        .shared(DataFilteringProfileLocationSharedArgs.builder()
            .build())
        .build())
    .dataCapture(false)
    .description("string")
    .disableOverride("string")
    .name("string")
    .rules(DataFilteringProfileRuleArgs.builder()
        .name("string")
        .alertThreshold(0.0)
        .applications("string")
        .blockThreshold(0.0)
        .dataObject("string")
        .direction("string")
        .fileTypes("string")
        .logSeverity("string")
        .build())
    .build());

    data_filtering_profile_resource = panos.DataFilteringProfile("dataFilteringProfileResource",
    location={
        "device_group": {
            "name": "string",
            "panorama_device": "string",
        },
        "shared": {},
    },
    data_capture=False,
    description="string",
    disable_override="string",
    name="string",
    rules=[{
        "name": "string",
        "alert_threshold": 0,
        "applications": ["string"],
        "block_threshold": 0,
        "data_object": "string",
        "direction": "string",
        "file_types": ["string"],
        "log_severity": "string",
    }])

    const dataFilteringProfileResource = new panos.DataFilteringProfile("dataFilteringProfileResource", {
    location: {
        deviceGroup: {
            name: "string",
            panoramaDevice: "string",
        },
        shared: {},
    },
    dataCapture: false,
    description: "string",
    disableOverride: "string",
    name: "string",
    rules: [{
        name: "string",
        alertThreshold: 0,
        applications: ["string"],
        blockThreshold: 0,
        dataObject: "string",
        direction: "string",
        fileTypes: ["string"],
        logSeverity: "string",
    }],
});

    type: panos:DataFilteringProfile
properties:
    dataCapture: false
    description: string
    disableOverride: string
    location:
        deviceGroup:
            name: string
            panoramaDevice: string
        shared: {}
    name: string
    rules:
        - alertThreshold: 0
          applications:
            - string
          blockThreshold: 0
          dataObject: string
          direction: string
          fileTypes:
            - string
          logSeverity: string
          name: string

    DataFilteringProfile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DataFilteringProfile resource accepts the following input properties:

    Location DataFilteringProfileLocation
    The location of this object.
    DataCapture bool
    Description string
    DisableOverride string
    disable object override in child device groups
    Name string
    Rules List<DataFilteringProfileRule>
    Location DataFilteringProfileLocationArgs
    The location of this object.
    DataCapture bool
    Description string
    DisableOverride string
    disable object override in child device groups
    Name string
    Rules []DataFilteringProfileRuleArgs
    location DataFilteringProfileLocation
    The location of this object.
    dataCapture Boolean
    description String
    disableOverride String
    disable object override in child device groups
    name String
    rules List<DataFilteringProfileRule>
    location DataFilteringProfileLocation
    The location of this object.
    dataCapture boolean
    description string
    disableOverride string
    disable object override in child device groups
    name string
    rules DataFilteringProfileRule[]
    location DataFilteringProfileLocationArgs
    The location of this object.
    data_capture bool
    description str
    disable_override str
    disable object override in child device groups
    name str
    rules Sequence[DataFilteringProfileRuleArgs]
    location Property Map
    The location of this object.
    dataCapture Boolean
    description String
    disableOverride String
    disable object override in child device groups
    name String
    rules List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataFilteringProfile resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DataFilteringProfile Resource

    Get an existing DataFilteringProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataFilteringProfileState, opts?: CustomResourceOptions): DataFilteringProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_capture: Optional[bool] = None,
        description: Optional[str] = None,
        disable_override: Optional[str] = None,
        location: Optional[DataFilteringProfileLocationArgs] = None,
        name: Optional[str] = None,
        rules: Optional[Sequence[DataFilteringProfileRuleArgs]] = None) -> DataFilteringProfile
    func GetDataFilteringProfile(ctx *Context, name string, id IDInput, state *DataFilteringProfileState, opts ...ResourceOption) (*DataFilteringProfile, error)
    public static DataFilteringProfile Get(string name, Input<string> id, DataFilteringProfileState? state, CustomResourceOptions? opts = null)
    public static DataFilteringProfile get(String name, Output<String> id, DataFilteringProfileState state, CustomResourceOptions options)
    resources:  _:    type: panos:DataFilteringProfile    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataCapture bool
    Description string
    DisableOverride string
    disable object override in child device groups
    Location DataFilteringProfileLocation
    The location of this object.
    Name string
    Rules List<DataFilteringProfileRule>
    DataCapture bool
    Description string
    DisableOverride string
    disable object override in child device groups
    Location DataFilteringProfileLocationArgs
    The location of this object.
    Name string
    Rules []DataFilteringProfileRuleArgs
    dataCapture Boolean
    description String
    disableOverride String
    disable object override in child device groups
    location DataFilteringProfileLocation
    The location of this object.
    name String
    rules List<DataFilteringProfileRule>
    dataCapture boolean
    description string
    disableOverride string
    disable object override in child device groups
    location DataFilteringProfileLocation
    The location of this object.
    name string
    rules DataFilteringProfileRule[]
    data_capture bool
    description str
    disable_override str
    disable object override in child device groups
    location DataFilteringProfileLocationArgs
    The location of this object.
    name str
    rules Sequence[DataFilteringProfileRuleArgs]
    dataCapture Boolean
    description String
    disableOverride String
    disable object override in child device groups
    location Property Map
    The location of this object.
    name String
    rules List<Property Map>

    Supporting Types

    DataFilteringProfileLocation, DataFilteringProfileLocationArgs

    deviceGroup Property Map
    Located in a specific Device Group
    shared Property Map
    Panorama shared object

    DataFilteringProfileLocationDeviceGroup, DataFilteringProfileLocationDeviceGroupArgs

    Name string
    Device Group name
    PanoramaDevice string
    Panorama device name
    Name string
    Device Group name
    PanoramaDevice string
    Panorama device name
    name String
    Device Group name
    panoramaDevice String
    Panorama device name
    name string
    Device Group name
    panoramaDevice string
    Panorama device name
    name str
    Device Group name
    panorama_device str
    Panorama device name
    name String
    Device Group name
    panoramaDevice String
    Panorama device name

    DataFilteringProfileRule, DataFilteringProfileRuleArgs

    Name string
    AlertThreshold double
    Applications List<string>
    BlockThreshold double
    DataObject string
    Direction string
    FileTypes List<string>
    LogSeverity string
    Name string
    AlertThreshold float64
    Applications []string
    BlockThreshold float64
    DataObject string
    Direction string
    FileTypes []string
    LogSeverity string
    name String
    alertThreshold Double
    applications List<String>
    blockThreshold Double
    dataObject String
    direction String
    fileTypes List<String>
    logSeverity String
    name string
    alertThreshold number
    applications string[]
    blockThreshold number
    dataObject string
    direction string
    fileTypes string[]
    logSeverity string
    name String
    alertThreshold Number
    applications List<String>
    blockThreshold Number
    dataObject String
    direction String
    fileTypes List<String>
    logSeverity String

    Package Details

    Repository
    panos paloaltonetworks/terraform-provider-panos
    License
    Notes
    This Pulumi package is based on the panos Terraform Provider.
    Viewing docs for panos 2.0.10
    published on Thursday, Apr 9, 2026 by paloaltonetworks
    Schema (JSON)
    paloaltonetworks/terraform-provider-panos
      Try Pulumi Cloud free. Your team will thank you.