1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. TrafficCaptureRule
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.TrafficCaptureRule

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia.TrafficCaptureRule resource manages traffic capture rules in the Zscaler Internet Access (ZIA) cloud. Traffic capture rules define criteria for capturing network traffic for analysis, specifying which traffic to capture based on source/destination IPs, locations, departments, users, applications, and other criteria.

    Example Usage

    Basic Traffic Capture Rule

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

const example = new zia.TrafficCaptureRule("example", {
    name: "Example Capture Rule",
    order: 1,
    description: "Managed by Pulumi",
    state: "ENABLED",
    action: "CAPTURE",
    srcIps: ["192.168.1.0/24"],
    destAddresses: ["10.0.0.0/8"],
});

    import zscaler_pulumi_zia as zia

example = zia.TrafficCaptureRule("example",
    name="Example Capture Rule",
    order=1,
    description="Managed by Pulumi",
    state="ENABLED",
    action="CAPTURE",
    src_ips=["192.168.1.0/24"],
    dest_addresses=["10.0.0.0/8"],
)

    resources:
  example:
    type: zia:TrafficCaptureRule
    properties:
      name: Example Capture Rule
      order: 1
      description: Managed by Pulumi
      state: ENABLED
      action: CAPTURE
      srcIps:
        - 192.168.1.0/24
      destAddresses:
        - 10.0.0.0/8

    Create TrafficCaptureRule Resource

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

    Constructor syntax

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

@overload
def TrafficCaptureRule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       order: Optional[int] = None,
                       dest_ip_groups: Optional[Sequence[int]] = None,
                       nw_applications: Optional[Sequence[str]] = None,
                       description: Optional[str] = None,
                       dest_addresses: Optional[Sequence[str]] = None,
                       dest_countries: Optional[Sequence[str]] = None,
                       dest_ip_categories: Optional[Sequence[str]] = None,
                       action: Optional[str] = None,
                       device_groups: Optional[Sequence[int]] = None,
                       device_trust_levels: Optional[Sequence[str]] = None,
                       devices: Optional[Sequence[int]] = None,
                       groups: Optional[Sequence[int]] = None,
                       labels: Optional[Sequence[int]] = None,
                       location_groups: Optional[Sequence[int]] = None,
                       locations: Optional[Sequence[int]] = None,
                       departments: Optional[Sequence[int]] = None,
                       default_rule: Optional[bool] = None,
                       nw_services: Optional[Sequence[int]] = None,
                       nw_service_groups: Optional[Sequence[int]] = None,
                       nw_application_groups: Optional[Sequence[int]] = None,
                       app_service_groups: Optional[Sequence[int]] = None,
                       predefined: Optional[bool] = None,
                       rank: Optional[int] = None,
                       source_countries: Optional[Sequence[str]] = None,
                       src_ip_groups: Optional[Sequence[int]] = None,
                       src_ips: Optional[Sequence[str]] = None,
                       state: Optional[str] = None,
                       time_windows: Optional[Sequence[int]] = None,
                       txn_sampling: Optional[str] = None,
                       txn_size_limit: Optional[str] = None,
                       users: Optional[Sequence[int]] = None,
                       workload_groups: Optional[Sequence[WorkloadGroupInputArgs]] = None)
    func NewTrafficCaptureRule(ctx *Context, name string, args TrafficCaptureRuleArgs, opts ...ResourceOption) (*TrafficCaptureRule, error)
    public TrafficCaptureRule(string name, TrafficCaptureRuleArgs args, CustomResourceOptions? opts = null)
    public TrafficCaptureRule(String name, TrafficCaptureRuleArgs args)
public TrafficCaptureRule(String name, TrafficCaptureRuleArgs args, CustomResourceOptions options)

    type: zia:TrafficCaptureRule
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 TrafficCaptureRuleArgs
    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 TrafficCaptureRuleArgs
    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 TrafficCaptureRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficCaptureRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficCaptureRuleArgs
    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 trafficCaptureRuleResource = new Zia.TrafficCaptureRule("trafficCaptureRuleResource", new()
{
    Name = "string",
    Order = 0,
    DestIpGroups = new[]
    {
        0,
    },
    NwApplications = new[]
    {
        "string",
    },
    Description = "string",
    DestAddresses = new[]
    {
        "string",
    },
    DestCountries = new[]
    {
        "string",
    },
    DestIpCategories = new[]
    {
        "string",
    },
    Action = "string",
    DeviceGroups = new[]
    {
        0,
    },
    DeviceTrustLevels = new[]
    {
        "string",
    },
    Devices = new[]
    {
        0,
    },
    Groups = new[]
    {
        0,
    },
    Labels = new[]
    {
        0,
    },
    LocationGroups = new[]
    {
        0,
    },
    Locations = new[]
    {
        0,
    },
    Departments = new[]
    {
        0,
    },
    DefaultRule = false,
    NwServices = new[]
    {
        0,
    },
    NwServiceGroups = new[]
    {
        0,
    },
    NwApplicationGroups = new[]
    {
        0,
    },
    AppServiceGroups = new[]
    {
        0,
    },
    Predefined = false,
    Rank = 0,
    SourceCountries = new[]
    {
        "string",
    },
    SrcIpGroups = new[]
    {
        0,
    },
    SrcIps = new[]
    {
        "string",
    },
    State = "string",
    TimeWindows = new[]
    {
        0,
    },
    TxnSampling = "string",
    TxnSizeLimit = "string",
    Users = new[]
    {
        0,
    },
    WorkloadGroups = new[]
    {
        new Zia.Inputs.WorkloadGroupInputArgs
        {
            ResourceId = 0,
            Name = "string",
        },
    },
});

    example, err := zia.NewTrafficCaptureRule(ctx, "trafficCaptureRuleResource", &zia.TrafficCaptureRuleArgs{
	Name:  pulumi.String("string"),
	Order: pulumi.Int(0),
	DestIpGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	NwApplications: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DestAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	DestCountries: pulumi.StringArray{
		pulumi.String("string"),
	},
	DestIpCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Action: pulumi.String("string"),
	DeviceGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	DeviceTrustLevels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Devices: pulumi.IntArray{
		pulumi.Int(0),
	},
	Groups: pulumi.IntArray{
		pulumi.Int(0),
	},
	Labels: pulumi.IntArray{
		pulumi.Int(0),
	},
	LocationGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	Locations: pulumi.IntArray{
		pulumi.Int(0),
	},
	Departments: pulumi.IntArray{
		pulumi.Int(0),
	},
	DefaultRule: pulumi.Bool(false),
	NwServices: pulumi.IntArray{
		pulumi.Int(0),
	},
	NwServiceGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	NwApplicationGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	AppServiceGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	Predefined: pulumi.Bool(false),
	Rank:       pulumi.Int(0),
	SourceCountries: pulumi.StringArray{
		pulumi.String("string"),
	},
	SrcIpGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	SrcIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	State: pulumi.String("string"),
	TimeWindows: pulumi.IntArray{
		pulumi.Int(0),
	},
	TxnSampling:  pulumi.String("string"),
	TxnSizeLimit: pulumi.String("string"),
	Users: pulumi.IntArray{
		pulumi.Int(0),
	},
	WorkloadGroups: pulumizia.WorkloadGroupInputTypeArray{
		&pulumizia.WorkloadGroupInputTypeArgs{
			ResourceId: pulumi.Int(0),
			Name:       pulumi.String("string"),
		},
	},
})

    var trafficCaptureRuleResource = new TrafficCaptureRule("trafficCaptureRuleResource", TrafficCaptureRuleArgs.builder()
    .name("string")
    .order(0)
    .destIpGroups(0)
    .nwApplications("string")
    .description("string")
    .destAddresses("string")
    .destCountries("string")
    .destIpCategories("string")
    .action("string")
    .deviceGroups(0)
    .deviceTrustLevels("string")
    .devices(0)
    .groups(0)
    .labels(0)
    .locationGroups(0)
    .locations(0)
    .departments(0)
    .defaultRule(false)
    .nwServices(0)
    .nwServiceGroups(0)
    .nwApplicationGroups(0)
    .appServiceGroups(0)
    .predefined(false)
    .rank(0)
    .sourceCountries("string")
    .srcIpGroups(0)
    .srcIps("string")
    .state("string")
    .timeWindows(0)
    .txnSampling("string")
    .txnSizeLimit("string")
    .users(0)
    .workloadGroups(WorkloadGroupInputArgs.builder()
        .resourceId(0)
        .name("string")
        .build())
    .build());

    traffic_capture_rule_resource = zia.TrafficCaptureRule("trafficCaptureRuleResource",
    name="string",
    order=0,
    dest_ip_groups=[0],
    nw_applications=["string"],
    description="string",
    dest_addresses=["string"],
    dest_countries=["string"],
    dest_ip_categories=["string"],
    action="string",
    device_groups=[0],
    device_trust_levels=["string"],
    devices=[0],
    groups=[0],
    labels=[0],
    location_groups=[0],
    locations=[0],
    departments=[0],
    default_rule=False,
    nw_services=[0],
    nw_service_groups=[0],
    nw_application_groups=[0],
    app_service_groups=[0],
    predefined=False,
    rank=0,
    source_countries=["string"],
    src_ip_groups=[0],
    src_ips=["string"],
    state="string",
    time_windows=[0],
    txn_sampling="string",
    txn_size_limit="string",
    users=[0],
    workload_groups=[{
        "resource_id": 0,
        "name": "string",
    }])

    const trafficCaptureRuleResource = new zia.TrafficCaptureRule("trafficCaptureRuleResource", {
    name: "string",
    order: 0,
    destIpGroups: [0],
    nwApplications: ["string"],
    description: "string",
    destAddresses: ["string"],
    destCountries: ["string"],
    destIpCategories: ["string"],
    action: "string",
    deviceGroups: [0],
    deviceTrustLevels: ["string"],
    devices: [0],
    groups: [0],
    labels: [0],
    locationGroups: [0],
    locations: [0],
    departments: [0],
    defaultRule: false,
    nwServices: [0],
    nwServiceGroups: [0],
    nwApplicationGroups: [0],
    appServiceGroups: [0],
    predefined: false,
    rank: 0,
    sourceCountries: ["string"],
    srcIpGroups: [0],
    srcIps: ["string"],
    state: "string",
    timeWindows: [0],
    txnSampling: "string",
    txnSizeLimit: "string",
    users: [0],
    workloadGroups: [{
        resourceId: 0,
        name: "string",
    }],
});

    type: zia:TrafficCaptureRule
properties:
    action: string
    appServiceGroups:
        - 0
    defaultRule: false
    departments:
        - 0
    description: string
    destAddresses:
        - string
    destCountries:
        - string
    destIpCategories:
        - string
    destIpGroups:
        - 0
    deviceGroups:
        - 0
    deviceTrustLevels:
        - string
    devices:
        - 0
    groups:
        - 0
    labels:
        - 0
    locationGroups:
        - 0
    locations:
        - 0
    name: string
    nwApplicationGroups:
        - 0
    nwApplications:
        - string
    nwServiceGroups:
        - 0
    nwServices:
        - 0
    order: 0
    predefined: false
    rank: 0
    sourceCountries:
        - string
    srcIpGroups:
        - 0
    srcIps:
        - string
    state: string
    timeWindows:
        - 0
    txnSampling: string
    txnSizeLimit: string
    users:
        - 0
    workloadGroups:
        - name: string
          resourceId: 0

    TrafficCaptureRule 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 TrafficCaptureRule resource accepts the following input properties:

    Name string
    Name of the traffic capture rule.
    Order int
    The rule order of execution for the traffic capture rule.
    Action string
    The action taken when traffic matches the rule (e.g., 'CAPTURE'). Default: 'CAPTURE'.
    AppServiceGroups List<int>
    List of application service group IDs.
    DefaultRule bool
    Whether this is a default rule.
    Departments List<int>
    List of department IDs.
    Description string
    Description of the traffic capture rule.
    DestAddresses List<string>
    List of destination addresses.
    DestCountries List<string>
    List of destination country codes.
    DestIpCategories List<string>
    List of destination IP categories.
    DestIpGroups List<int>
    List of destination IP group IDs.
    DeviceGroups List<int>
    List of device group IDs.
    DeviceTrustLevels List<string>
    List of device trust levels.
    Devices List<int>
    List of device IDs.
    Groups List<int>
    List of group IDs.
    Labels List<int>
    List of label IDs.
    LocationGroups List<int>
    List of location group IDs.
    Locations List<int>
    List of location IDs.
    NwApplicationGroups List<int>
    List of network application group IDs.
    NwApplications List<string>
    List of network applications.
    NwServiceGroups List<int>
    List of network service group IDs.
    NwServices List<int>
    List of network service IDs.
    Predefined bool
    Whether this is a predefined rule.
    Rank int
    The admin rank of the rule. Default is 7.
    SourceCountries List<string>
    List of source country codes.
    SrcIpGroups List<int>
    List of source IP group IDs.
    SrcIps List<string>
    List of source IP addresses or CIDR ranges.
    State string
    The rule state. Accepted values: 'ENABLED' or 'DISABLED'. Default: 'ENABLED'.
    TimeWindows List<int>
    List of time window IDs.
    TxnSampling string
    Transaction sampling mode. Default: 'NONE'.
    TxnSizeLimit string
    Transaction size limit. Default: 'NONE'.
    Users List<int>
    List of user IDs.
    WorkloadGroups List<zscaler.PulumiPackage.Zia.Inputs.WorkloadGroupInput>
    List of workload groups.
    Name string
    Name of the traffic capture rule.
    Order int
    The rule order of execution for the traffic capture rule.
    Action string
    The action taken when traffic matches the rule (e.g., 'CAPTURE'). Default: 'CAPTURE'.
    AppServiceGroups []int
    List of application service group IDs.
    DefaultRule bool
    Whether this is a default rule.
    Departments []int
    List of department IDs.
    Description string
    Description of the traffic capture rule.
    DestAddresses []string
    List of destination addresses.
    DestCountries []string
    List of destination country codes.
    DestIpCategories []string
    List of destination IP categories.
    DestIpGroups []int
    List of destination IP group IDs.
    DeviceGroups []int
    List of device group IDs.
    DeviceTrustLevels []string
    List of device trust levels.
    Devices []int
    List of device IDs.
    Groups []int
    List of group IDs.
    Labels []int
    List of label IDs.
    LocationGroups []int
    List of location group IDs.
    Locations []int
    List of location IDs.
    NwApplicationGroups []int
    List of network application group IDs.
    NwApplications []string
    List of network applications.
    NwServiceGroups []int
    List of network service group IDs.
    NwServices []int
    List of network service IDs.
    Predefined bool
    Whether this is a predefined rule.
    Rank int
    The admin rank of the rule. Default is 7.
    SourceCountries []string
    List of source country codes.
    SrcIpGroups []int
    List of source IP group IDs.
    SrcIps []string
    List of source IP addresses or CIDR ranges.
    State string
    The rule state. Accepted values: 'ENABLED' or 'DISABLED'. Default: 'ENABLED'.
    TimeWindows []int
    List of time window IDs.
    TxnSampling string
    Transaction sampling mode. Default: 'NONE'.
    TxnSizeLimit string
    Transaction size limit. Default: 'NONE'.
    Users []int
    List of user IDs.
    WorkloadGroups []WorkloadGroupInputTypeArgs
    List of workload groups.
    name String
    Name of the traffic capture rule.
    order Integer
    The rule order of execution for the traffic capture rule.
    action String
    The action taken when traffic matches the rule (e.g., 'CAPTURE'). Default: 'CAPTURE'.
    appServiceGroups List<Integer>
    List of application service group IDs.
    defaultRule Boolean
    Whether this is a default rule.
    departments List<Integer>
    List of department IDs.
    description String
    Description of the traffic capture rule.
    destAddresses List<String>
    List of destination addresses.
    destCountries List<String>
    List of destination country codes.
    destIpCategories List<String>
    List of destination IP categories.
    destIpGroups List<Integer>
    List of destination IP group IDs.
    deviceGroups List<Integer>
    List of device group IDs.
    deviceTrustLevels List<String>
    List of device trust levels.
    devices List<Integer>
    List of device IDs.
    groups List<Integer>
    List of group IDs.
    labels List<Integer>
    List of label IDs.
    locationGroups List<Integer>
    List of location group IDs.
    locations List<Integer>
    List of location IDs.
    nwApplicationGroups List<Integer>
    List of network application group IDs.
    nwApplications List<String>
    List of network applications.
    nwServiceGroups List<Integer>
    List of network service group IDs.
    nwServices List<Integer>
    List of network service IDs.
    predefined Boolean
    Whether this is a predefined rule.
    rank Integer
    The admin rank of the rule. Default is 7.
    sourceCountries List<String>
    List of source country codes.
    srcIpGroups List<Integer>
    List of source IP group IDs.
    srcIps List<String>
    List of source IP addresses or CIDR ranges.
    state String
    The rule state. Accepted values: 'ENABLED' or 'DISABLED'. Default: 'ENABLED'.
    timeWindows List<Integer>
    List of time window IDs.
    txnSampling String
    Transaction sampling mode. Default: 'NONE'.
    txnSizeLimit String
    Transaction size limit. Default: 'NONE'.
    users List<Integer>
    List of user IDs.
    workloadGroups List<WorkloadGroupInput>
    List of workload groups.
    name string
    Name of the traffic capture rule.
    order number
    The rule order of execution for the traffic capture rule.
    action string
    The action taken when traffic matches the rule (e.g., 'CAPTURE'). Default: 'CAPTURE'.
    appServiceGroups number[]
    List of application service group IDs.
    defaultRule boolean
    Whether this is a default rule.
    departments number[]
    List of department IDs.
    description string
    Description of the traffic capture rule.
    destAddresses string[]
    List of destination addresses.
    destCountries string[]
    List of destination country codes.
    destIpCategories string[]
    List of destination IP categories.
    destIpGroups number[]
    List of destination IP group IDs.
    deviceGroups number[]
    List of device group IDs.
    deviceTrustLevels string[]
    List of device trust levels.
    devices number[]
    List of device IDs.
    groups number[]
    List of group IDs.
    labels number[]
    List of label IDs.
    locationGroups number[]
    List of location group IDs.
    locations number[]
    List of location IDs.
    nwApplicationGroups number[]
    List of network application group IDs.
    nwApplications string[]
    List of network applications.
    nwServiceGroups number[]
    List of network service group IDs.
    nwServices number[]
    List of network service IDs.
    predefined boolean
    Whether this is a predefined rule.
    rank number
    The admin rank of the rule. Default is 7.
    sourceCountries string[]
    List of source country codes.
    srcIpGroups number[]
    List of source IP group IDs.
    srcIps string[]
    List of source IP addresses or CIDR ranges.
    state string
    The rule state. Accepted values: 'ENABLED' or 'DISABLED'. Default: 'ENABLED'.
    timeWindows number[]
    List of time window IDs.
    txnSampling string
    Transaction sampling mode. Default: 'NONE'.
    txnSizeLimit string
    Transaction size limit. Default: 'NONE'.
    users number[]
    List of user IDs.
    workloadGroups WorkloadGroupInput[]
    List of workload groups.
    name str
    Name of the traffic capture rule.
    order int
    The rule order of execution for the traffic capture rule.
    action str
    The action taken when traffic matches the rule (e.g., 'CAPTURE'). Default: 'CAPTURE'.
    app_service_groups Sequence[int]
    List of application service group IDs.
    default_rule bool
    Whether this is a default rule.
    departments Sequence[int]
    List of department IDs.
    description str
    Description of the traffic capture rule.
    dest_addresses Sequence[str]
    List of destination addresses.
    dest_countries Sequence[str]
    List of destination country codes.
    dest_ip_categories Sequence[str]
    List of destination IP categories.
    dest_ip_groups Sequence[int]
    List of destination IP group IDs.
    device_groups Sequence[int]
    List of device group IDs.
    device_trust_levels Sequence[str]
    List of device trust levels.
    devices Sequence[int]
    List of device IDs.
    groups Sequence[int]
    List of group IDs.
    labels Sequence[int]
    List of label IDs.
    location_groups Sequence[int]
    List of location group IDs.
    locations Sequence[int]
    List of location IDs.
    nw_application_groups Sequence[int]
    List of network application group IDs.
    nw_applications Sequence[str]
    List of network applications.
    nw_service_groups Sequence[int]
    List of network service group IDs.
    nw_services Sequence[int]
    List of network service IDs.
    predefined bool
    Whether this is a predefined rule.
    rank int
    The admin rank of the rule. Default is 7.
    source_countries Sequence[str]
    List of source country codes.
    src_ip_groups Sequence[int]
    List of source IP group IDs.
    src_ips Sequence[str]
    List of source IP addresses or CIDR ranges.
    state str
    The rule state. Accepted values: 'ENABLED' or 'DISABLED'. Default: 'ENABLED'.
    time_windows Sequence[int]
    List of time window IDs.
    txn_sampling str
    Transaction sampling mode. Default: 'NONE'.
    txn_size_limit str
    Transaction size limit. Default: 'NONE'.
    users Sequence[int]
    List of user IDs.
    workload_groups Sequence[WorkloadGroupInputArgs]
    List of workload groups.
    name String
    Name of the traffic capture rule.
    order Number
    The rule order of execution for the traffic capture rule.
    action String
    The action taken when traffic matches the rule (e.g., 'CAPTURE'). Default: 'CAPTURE'.
    appServiceGroups List<Number>
    List of application service group IDs.
    defaultRule Boolean
    Whether this is a default rule.
    departments List<Number>
    List of department IDs.
    description String
    Description of the traffic capture rule.
    destAddresses List<String>
    List of destination addresses.
    destCountries List<String>
    List of destination country codes.
    destIpCategories List<String>
    List of destination IP categories.
    destIpGroups List<Number>
    List of destination IP group IDs.
    deviceGroups List<Number>
    List of device group IDs.
    deviceTrustLevels List<String>
    List of device trust levels.
    devices List<Number>
    List of device IDs.
    groups List<Number>
    List of group IDs.
    labels List<Number>
    List of label IDs.
    locationGroups List<Number>
    List of location group IDs.
    locations List<Number>
    List of location IDs.
    nwApplicationGroups List<Number>
    List of network application group IDs.
    nwApplications List<String>
    List of network applications.
    nwServiceGroups List<Number>
    List of network service group IDs.
    nwServices List<Number>
    List of network service IDs.
    predefined Boolean
    Whether this is a predefined rule.
    rank Number
    The admin rank of the rule. Default is 7.
    sourceCountries List<String>
    List of source country codes.
    srcIpGroups List<Number>
    List of source IP group IDs.
    srcIps List<String>
    List of source IP addresses or CIDR ranges.
    state String
    The rule state. Accepted values: 'ENABLED' or 'DISABLED'. Default: 'ENABLED'.
    timeWindows List<Number>
    List of time window IDs.
    txnSampling String
    Transaction sampling mode. Default: 'NONE'.
    txnSizeLimit String
    Transaction size limit. Default: 'NONE'.
    users List<Number>
    List of user IDs.
    workloadGroups List<Property Map>
    List of workload groups.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId int
    The unique identifier for the traffic capture rule assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId int
    The unique identifier for the traffic capture rule assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId Integer
    The unique identifier for the traffic capture rule assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId number
    The unique identifier for the traffic capture rule assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id int
    The unique identifier for the traffic capture rule assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId Number
    The unique identifier for the traffic capture rule assigned by the ZIA cloud.

    Supporting Types

    WorkloadGroupInput, WorkloadGroupInputArgs

    ResourceId int
    Name string
    ResourceId int
    Name string
    resourceId Integer
    name String
    resourceId number
    name string
    resourceId Number
    name String

    Import

    An existing traffic capture rule can be imported using its ID, e.g.

    $ pulumi import zia:index:TrafficCaptureRule example 12345

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.