Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. SandboxRules
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

zia.SandboxRules

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

    The zia_sandbox_rules resource allows the creation and management of SAndbox rules in the Zscaler Internet Access.

    Example Usage

    data "zia_department_management" "engineering" {
 name = "Engineering"
}

data "zia_group_management" "normal_internet" {
    name = "Normal_Internet"
}

resource "zia_sandbox_rules" "this" {
    name                 = "SandboxRule01"
    description          = "SandboxRule01"
    rank                 = 7
    order                = 1
    first_time_enable    = true
    ml_action_enabled    = true
    first_time_operation = "ALLOW_SCAN"
    ba_rule_action       = "BLOCK"
    state                = "ENABLED"
    ba_policy_categories = ["ADWARE_BLOCK", "BOTMAL_BLOCK", "ANONYP2P_BLOCK", "RANSOMWARE_BLOCK"]
    file_types           = ["FTCATEGORY_P7Z",
        "FTCATEGORY_MS_WORD",
        "FTCATEGORY_PDF_DOCUMENT",
        "FTCATEGORY_TAR",
        "FTCATEGORY_SCZIP",
        "FTCATEGORY_WINDOWS_EXECUTABLES",
        "FTCATEGORY_HTA",
        "FTCATEGORY_FLASH",
        "FTCATEGORY_RAR",
        "FTCATEGORY_MS_EXCEL",
        "FTCATEGORY_VISUAL_BASIC_SCRIPT",
        "FTCATEGORY_MS_POWERPOINT",
        "FTCATEGORY_WINDOWS_LIBRARY",
        "FTCATEGORY_POWERSHELL",
        "FTCATEGORY_APK",
        "FTCATEGORY_ZIP",
        "FTCATEGORY_BZIP2",
        "FTCATEGORY_JAVA_APPLET",
        "FTCATEGORY_MS_RTF"]
    protocols            = [
        "FOHTTP_RULE",
        "FTP_RULE",
        "HTTPS_RULE",
        "HTTP_RULE",
    ]
    departments {
        id = [ data.zia_department_management.engineering.id ]
    }
    groups {
        id = [ data.zia_group_management.normal_internet.id ]
    }
}

    Create SandboxRules Resource

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

    Constructor syntax

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

@overload
def SandboxRules(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 protocols: Optional[Sequence[str]] = None,
                 file_types: Optional[Sequence[str]] = None,
                 order: Optional[int] = None,
                 locations: Optional[SandboxRulesLocationsArgs] = None,
                 location_groups: Optional[SandboxRulesLocationGroupsArgs] = None,
                 departments: Optional[SandboxRulesDepartmentsArgs] = None,
                 first_time_enable: Optional[bool] = None,
                 first_time_operation: Optional[str] = None,
                 groups: Optional[SandboxRulesGroupsArgs] = None,
                 labels: Optional[SandboxRulesLabelsArgs] = None,
                 ba_rule_action: Optional[str] = None,
                 ml_action_enabled: Optional[bool] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 by_threat_score: Optional[int] = None,
                 ba_policy_categories: Optional[Sequence[str]] = None,
                 rank: Optional[int] = None,
                 state: Optional[str] = None,
                 url_categories: Optional[Sequence[str]] = None,
                 users: Optional[SandboxRulesUsersArgs] = None,
                 zpa_app_segments: Optional[Sequence[SandboxRulesZpaAppSegmentArgs]] = None)
    func NewSandboxRules(ctx *Context, name string, args SandboxRulesArgs, opts ...ResourceOption) (*SandboxRules, error)
    public SandboxRules(string name, SandboxRulesArgs args, CustomResourceOptions? opts = null)
    public SandboxRules(String name, SandboxRulesArgs args)
public SandboxRules(String name, SandboxRulesArgs args, CustomResourceOptions options)

    type: zia:SandboxRules
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 SandboxRulesArgs
    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 SandboxRulesArgs
    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 SandboxRulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SandboxRulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SandboxRulesArgs
    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 sandboxRulesResource = new Zia.SandboxRules("sandboxRulesResource", new()
{
    Protocols = new[]
    {
        "string",
    },
    FileTypes = new[]
    {
        "string",
    },
    Order = 0,
    Locations = new Zia.Inputs.SandboxRulesLocationsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    LocationGroups = new Zia.Inputs.SandboxRulesLocationGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Departments = new Zia.Inputs.SandboxRulesDepartmentsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    FirstTimeEnable = false,
    FirstTimeOperation = "string",
    Groups = new Zia.Inputs.SandboxRulesGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Labels = new Zia.Inputs.SandboxRulesLabelsArgs
    {
        Id = 0,
    },
    BaRuleAction = "string",
    MlActionEnabled = false,
    Description = "string",
    Name = "string",
    ByThreatScore = 0,
    BaPolicyCategories = new[]
    {
        "string",
    },
    Rank = 0,
    State = "string",
    UrlCategories = new[]
    {
        "string",
    },
    Users = new Zia.Inputs.SandboxRulesUsersArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    ZpaAppSegments = new[]
    {
        new Zia.Inputs.SandboxRulesZpaAppSegmentArgs
        {
            ExternalId = "string",
            Name = "string",
        },
    },
});

    example, err := zia.NewSandboxRules(ctx, "sandboxRulesResource", &zia.SandboxRulesArgs{
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	FileTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Order: pulumi.Int(0),
	Locations: &zia.SandboxRulesLocationsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	LocationGroups: &zia.SandboxRulesLocationGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Departments: &zia.SandboxRulesDepartmentsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	FirstTimeEnable:    pulumi.Bool(false),
	FirstTimeOperation: pulumi.String("string"),
	Groups: &zia.SandboxRulesGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Labels: &zia.SandboxRulesLabelsArgs{
		Id: pulumi.Int(0),
	},
	BaRuleAction:    pulumi.String("string"),
	MlActionEnabled: pulumi.Bool(false),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	ByThreatScore:   pulumi.Int(0),
	BaPolicyCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Rank:  pulumi.Int(0),
	State: pulumi.String("string"),
	UrlCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Users: &zia.SandboxRulesUsersArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	ZpaAppSegments: zia.SandboxRulesZpaAppSegmentArray{
		&zia.SandboxRulesZpaAppSegmentArgs{
			ExternalId: pulumi.String("string"),
			Name:       pulumi.String("string"),
		},
	},
})

    var sandboxRulesResource = new SandboxRules("sandboxRulesResource", SandboxRulesArgs.builder()
    .protocols("string")
    .fileTypes("string")
    .order(0)
    .locations(SandboxRulesLocationsArgs.builder()
        .ids(0)
        .build())
    .locationGroups(SandboxRulesLocationGroupsArgs.builder()
        .ids(0)
        .build())
    .departments(SandboxRulesDepartmentsArgs.builder()
        .ids(0)
        .build())
    .firstTimeEnable(false)
    .firstTimeOperation("string")
    .groups(SandboxRulesGroupsArgs.builder()
        .ids(0)
        .build())
    .labels(SandboxRulesLabelsArgs.builder()
        .id(0)
        .build())
    .baRuleAction("string")
    .mlActionEnabled(false)
    .description("string")
    .name("string")
    .byThreatScore(0)
    .baPolicyCategories("string")
    .rank(0)
    .state("string")
    .urlCategories("string")
    .users(SandboxRulesUsersArgs.builder()
        .ids(0)
        .build())
    .zpaAppSegments(SandboxRulesZpaAppSegmentArgs.builder()
        .externalId("string")
        .name("string")
        .build())
    .build());

    sandbox_rules_resource = zia.SandboxRules("sandboxRulesResource",
    protocols=["string"],
    file_types=["string"],
    order=0,
    locations={
        "ids": [0],
    },
    location_groups={
        "ids": [0],
    },
    departments={
        "ids": [0],
    },
    first_time_enable=False,
    first_time_operation="string",
    groups={
        "ids": [0],
    },
    labels={
        "id": 0,
    },
    ba_rule_action="string",
    ml_action_enabled=False,
    description="string",
    name="string",
    by_threat_score=0,
    ba_policy_categories=["string"],
    rank=0,
    state="string",
    url_categories=["string"],
    users={
        "ids": [0],
    },
    zpa_app_segments=[{
        "external_id": "string",
        "name": "string",
    }])

    const sandboxRulesResource = new zia.SandboxRules("sandboxRulesResource", {
    protocols: ["string"],
    fileTypes: ["string"],
    order: 0,
    locations: {
        ids: [0],
    },
    locationGroups: {
        ids: [0],
    },
    departments: {
        ids: [0],
    },
    firstTimeEnable: false,
    firstTimeOperation: "string",
    groups: {
        ids: [0],
    },
    labels: {
        id: 0,
    },
    baRuleAction: "string",
    mlActionEnabled: false,
    description: "string",
    name: "string",
    byThreatScore: 0,
    baPolicyCategories: ["string"],
    rank: 0,
    state: "string",
    urlCategories: ["string"],
    users: {
        ids: [0],
    },
    zpaAppSegments: [{
        externalId: "string",
        name: "string",
    }],
});

    type: zia:SandboxRules
properties:
    baPolicyCategories:
        - string
    baRuleAction: string
    byThreatScore: 0
    departments:
        ids:
            - 0
    description: string
    fileTypes:
        - string
    firstTimeEnable: false
    firstTimeOperation: string
    groups:
        ids:
            - 0
    labels:
        id: 0
    locationGroups:
        ids:
            - 0
    locations:
        ids:
            - 0
    mlActionEnabled: false
    name: string
    order: 0
    protocols:
        - string
    rank: 0
    state: string
    urlCategories:
        - string
    users:
        ids:
            - 0
    zpaAppSegments:
        - externalId: string
          name: string

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

    FileTypes List<string>
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    Order int
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    Protocols List<string>
    Protocol for the given rule. This field is not applicable to the Lite API.
    BaPolicyCategories List<string>
    The threat categories to which the rule applies
    BaRuleAction string
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    ByThreatScore int
    (Integer)
    Departments zscaler.PulumiPackage.Zia.Inputs.SandboxRulesDepartments
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    Description string
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    FirstTimeEnable bool
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    FirstTimeOperation string
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    Groups zscaler.PulumiPackage.Zia.Inputs.SandboxRulesGroups
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    Labels zscaler.PulumiPackage.Zia.Inputs.SandboxRulesLabels
    (List of Objects) Labels that are applicable to the rule.
    LocationGroups zscaler.PulumiPackage.Zia.Inputs.SandboxRulesLocationGroups
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    Locations zscaler.PulumiPackage.Zia.Inputs.SandboxRulesLocations
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    MlActionEnabled bool
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    Name string
    The File Type Control policy rule name.
    Rank int
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    State string
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    UrlCategories List<string>
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    Users zscaler.PulumiPackage.Zia.Inputs.SandboxRulesUsers
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    ZpaAppSegments List<zscaler.PulumiPackage.Zia.Inputs.SandboxRulesZpaAppSegment>
    (List of Objects) The ZPA application segments to which the rule applies
    FileTypes []string
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    Order int
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    Protocols []string
    Protocol for the given rule. This field is not applicable to the Lite API.
    BaPolicyCategories []string
    The threat categories to which the rule applies
    BaRuleAction string
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    ByThreatScore int
    (Integer)
    Departments SandboxRulesDepartmentsArgs
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    Description string
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    FirstTimeEnable bool
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    FirstTimeOperation string
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    Groups SandboxRulesGroupsArgs
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    Labels SandboxRulesLabelsArgs
    (List of Objects) Labels that are applicable to the rule.
    LocationGroups SandboxRulesLocationGroupsArgs
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    Locations SandboxRulesLocationsArgs
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    MlActionEnabled bool
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    Name string
    The File Type Control policy rule name.
    Rank int
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    State string
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    UrlCategories []string
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    Users SandboxRulesUsersArgs
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    ZpaAppSegments []SandboxRulesZpaAppSegmentArgs
    (List of Objects) The ZPA application segments to which the rule applies
    fileTypes List<String>
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    order Integer
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols List<String>
    Protocol for the given rule. This field is not applicable to the Lite API.
    baPolicyCategories List<String>
    The threat categories to which the rule applies
    baRuleAction String
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    byThreatScore Integer
    (Integer)
    departments SandboxRulesDepartments
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description String
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    firstTimeEnable Boolean
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    firstTimeOperation String
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups SandboxRulesGroups
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels SandboxRulesLabels
    (List of Objects) Labels that are applicable to the rule.
    locationGroups SandboxRulesLocationGroups
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations SandboxRulesLocations
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    mlActionEnabled Boolean
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name String
    The File Type Control policy rule name.
    rank Integer
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    state String
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    urlCategories List<String>
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users SandboxRulesUsers
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpaAppSegments List<SandboxRulesZpaAppSegment>
    (List of Objects) The ZPA application segments to which the rule applies
    fileTypes string[]
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    order number
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols string[]
    Protocol for the given rule. This field is not applicable to the Lite API.
    baPolicyCategories string[]
    The threat categories to which the rule applies
    baRuleAction string
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    byThreatScore number
    (Integer)
    departments SandboxRulesDepartments
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description string
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    firstTimeEnable boolean
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    firstTimeOperation string
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups SandboxRulesGroups
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels SandboxRulesLabels
    (List of Objects) Labels that are applicable to the rule.
    locationGroups SandboxRulesLocationGroups
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations SandboxRulesLocations
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    mlActionEnabled boolean
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name string
    The File Type Control policy rule name.
    rank number
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    state string
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    urlCategories string[]
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users SandboxRulesUsers
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpaAppSegments SandboxRulesZpaAppSegment[]
    (List of Objects) The ZPA application segments to which the rule applies
    file_types Sequence[str]
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    order int
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols Sequence[str]
    Protocol for the given rule. This field is not applicable to the Lite API.
    ba_policy_categories Sequence[str]
    The threat categories to which the rule applies
    ba_rule_action str
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    by_threat_score int
    (Integer)
    departments SandboxRulesDepartmentsArgs
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description str
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    first_time_enable bool
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    first_time_operation str
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups SandboxRulesGroupsArgs
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels SandboxRulesLabelsArgs
    (List of Objects) Labels that are applicable to the rule.
    location_groups SandboxRulesLocationGroupsArgs
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations SandboxRulesLocationsArgs
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    ml_action_enabled bool
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name str
    The File Type Control policy rule name.
    rank int
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    state str
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    url_categories Sequence[str]
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users SandboxRulesUsersArgs
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpa_app_segments Sequence[SandboxRulesZpaAppSegmentArgs]
    (List of Objects) The ZPA application segments to which the rule applies
    fileTypes List<String>
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    order Number
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols List<String>
    Protocol for the given rule. This field is not applicable to the Lite API.
    baPolicyCategories List<String>
    The threat categories to which the rule applies
    baRuleAction String
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    byThreatScore Number
    (Integer)
    departments Property Map
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description String
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    firstTimeEnable Boolean
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    firstTimeOperation String
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups Property Map
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels Property Map
    (List of Objects) Labels that are applicable to the rule.
    locationGroups Property Map
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations Property Map
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    mlActionEnabled Boolean
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name String
    The File Type Control policy rule name.
    rank Number
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    state String
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    urlCategories List<String>
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users Property Map
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpaAppSegments List<Property Map>
    (List of Objects) The ZPA application segments to which the rule applies

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId int
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId int
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId Integer
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId number
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id int
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId Number

    Look up Existing SandboxRules Resource

    Get an existing SandboxRules 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?: SandboxRulesState, opts?: CustomResourceOptions): SandboxRules
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ba_policy_categories: Optional[Sequence[str]] = None,
        ba_rule_action: Optional[str] = None,
        by_threat_score: Optional[int] = None,
        departments: Optional[SandboxRulesDepartmentsArgs] = None,
        description: Optional[str] = None,
        file_types: Optional[Sequence[str]] = None,
        first_time_enable: Optional[bool] = None,
        first_time_operation: Optional[str] = None,
        groups: Optional[SandboxRulesGroupsArgs] = None,
        labels: Optional[SandboxRulesLabelsArgs] = None,
        location_groups: Optional[SandboxRulesLocationGroupsArgs] = None,
        locations: Optional[SandboxRulesLocationsArgs] = None,
        ml_action_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        order: Optional[int] = None,
        protocols: Optional[Sequence[str]] = None,
        rank: Optional[int] = None,
        rule_id: Optional[int] = None,
        state: Optional[str] = None,
        url_categories: Optional[Sequence[str]] = None,
        users: Optional[SandboxRulesUsersArgs] = None,
        zpa_app_segments: Optional[Sequence[SandboxRulesZpaAppSegmentArgs]] = None) -> SandboxRules
    func GetSandboxRules(ctx *Context, name string, id IDInput, state *SandboxRulesState, opts ...ResourceOption) (*SandboxRules, error)
    public static SandboxRules Get(string name, Input<string> id, SandboxRulesState? state, CustomResourceOptions? opts = null)
    public static SandboxRules get(String name, Output<String> id, SandboxRulesState state, CustomResourceOptions options)
    resources:  _:    type: zia:SandboxRules    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:
    BaPolicyCategories List<string>
    The threat categories to which the rule applies
    BaRuleAction string
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    ByThreatScore int
    (Integer)
    Departments zscaler.PulumiPackage.Zia.Inputs.SandboxRulesDepartments
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    Description string
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    FileTypes List<string>
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    FirstTimeEnable bool
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    FirstTimeOperation string
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    Groups zscaler.PulumiPackage.Zia.Inputs.SandboxRulesGroups
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    Labels zscaler.PulumiPackage.Zia.Inputs.SandboxRulesLabels
    (List of Objects) Labels that are applicable to the rule.
    LocationGroups zscaler.PulumiPackage.Zia.Inputs.SandboxRulesLocationGroups
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    Locations zscaler.PulumiPackage.Zia.Inputs.SandboxRulesLocations
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    MlActionEnabled bool
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    Name string
    The File Type Control policy rule name.
    Order int
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    Protocols List<string>
    Protocol for the given rule. This field is not applicable to the Lite API.
    Rank int
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    RuleId int
    State string
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    UrlCategories List<string>
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    Users zscaler.PulumiPackage.Zia.Inputs.SandboxRulesUsers
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    ZpaAppSegments List<zscaler.PulumiPackage.Zia.Inputs.SandboxRulesZpaAppSegment>
    (List of Objects) The ZPA application segments to which the rule applies
    BaPolicyCategories []string
    The threat categories to which the rule applies
    BaRuleAction string
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    ByThreatScore int
    (Integer)
    Departments SandboxRulesDepartmentsArgs
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    Description string
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    FileTypes []string
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    FirstTimeEnable bool
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    FirstTimeOperation string
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    Groups SandboxRulesGroupsArgs
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    Labels SandboxRulesLabelsArgs
    (List of Objects) Labels that are applicable to the rule.
    LocationGroups SandboxRulesLocationGroupsArgs
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    Locations SandboxRulesLocationsArgs
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    MlActionEnabled bool
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    Name string
    The File Type Control policy rule name.
    Order int
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    Protocols []string
    Protocol for the given rule. This field is not applicable to the Lite API.
    Rank int
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    RuleId int
    State string
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    UrlCategories []string
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    Users SandboxRulesUsersArgs
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    ZpaAppSegments []SandboxRulesZpaAppSegmentArgs
    (List of Objects) The ZPA application segments to which the rule applies
    baPolicyCategories List<String>
    The threat categories to which the rule applies
    baRuleAction String
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    byThreatScore Integer
    (Integer)
    departments SandboxRulesDepartments
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description String
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    fileTypes List<String>
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    firstTimeEnable Boolean
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    firstTimeOperation String
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups SandboxRulesGroups
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels SandboxRulesLabels
    (List of Objects) Labels that are applicable to the rule.
    locationGroups SandboxRulesLocationGroups
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations SandboxRulesLocations
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    mlActionEnabled Boolean
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name String
    The File Type Control policy rule name.
    order Integer
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols List<String>
    Protocol for the given rule. This field is not applicable to the Lite API.
    rank Integer
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    ruleId Integer
    state String
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    urlCategories List<String>
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users SandboxRulesUsers
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpaAppSegments List<SandboxRulesZpaAppSegment>
    (List of Objects) The ZPA application segments to which the rule applies
    baPolicyCategories string[]
    The threat categories to which the rule applies
    baRuleAction string
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    byThreatScore number
    (Integer)
    departments SandboxRulesDepartments
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description string
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    fileTypes string[]
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    firstTimeEnable boolean
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    firstTimeOperation string
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups SandboxRulesGroups
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels SandboxRulesLabels
    (List of Objects) Labels that are applicable to the rule.
    locationGroups SandboxRulesLocationGroups
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations SandboxRulesLocations
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    mlActionEnabled boolean
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name string
    The File Type Control policy rule name.
    order number
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols string[]
    Protocol for the given rule. This field is not applicable to the Lite API.
    rank number
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    ruleId number
    state string
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    urlCategories string[]
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users SandboxRulesUsers
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpaAppSegments SandboxRulesZpaAppSegment[]
    (List of Objects) The ZPA application segments to which the rule applies
    ba_policy_categories Sequence[str]
    The threat categories to which the rule applies
    ba_rule_action str
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    by_threat_score int
    (Integer)
    departments SandboxRulesDepartmentsArgs
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description str
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    file_types Sequence[str]
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    first_time_enable bool
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    first_time_operation str
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups SandboxRulesGroupsArgs
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels SandboxRulesLabelsArgs
    (List of Objects) Labels that are applicable to the rule.
    location_groups SandboxRulesLocationGroupsArgs
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations SandboxRulesLocationsArgs
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    ml_action_enabled bool
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name str
    The File Type Control policy rule name.
    order int
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols Sequence[str]
    Protocol for the given rule. This field is not applicable to the Lite API.
    rank int
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    rule_id int
    state str
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    url_categories Sequence[str]
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users SandboxRulesUsersArgs
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpa_app_segments Sequence[SandboxRulesZpaAppSegmentArgs]
    (List of Objects) The ZPA application segments to which the rule applies
    baPolicyCategories List<String>
    The threat categories to which the rule applies
    baRuleAction String
    (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK
    byThreatScore Number
    (Integer)
    departments Property Map
    (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.
    description String
    (String) Enter additional notes or information. The description cannot exceed 10,240 characters.
    fileTypes List<String>
    (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.
    firstTimeEnable Boolean
    (Boolean) A Boolean value indicating whether a First-Time Action is specifically configured for the rule. The First-Time Action takes place when users download unknown files. The action to be applied is specified using the firstTimeOperation field.
    firstTimeOperation String
    (String) The action that must take place when users download unknown files for the first time. Supported Values: ALLOW_SCAN, QUARANTINE, ALLOW_NOSCAN, QUARANTINE_ISOLATE
    groups Property Map
    (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.
    labels Property Map
    (List of Objects) Labels that are applicable to the rule.
    locationGroups Property Map
    (List of Objects)You can manually select up to 32 location groups. When not used it implies Any to apply the rule to all location groups.
    locations Property Map
    (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.
    mlActionEnabled Boolean
    (Boolean) A Boolean value indicating whether to enable or disable the AI Instant Verdict option to have the Zscaler service use AI analysis to instantly assign threat scores to unknown files. This option is available to use only with specific rule actions such as Quarantine and Allow and Scan for First-Time Action.
    name String
    The File Type Control policy rule name.
    order Number
    (Integer) Policy rules are evaluated in ascending numerical order (Rule 1 before Rule 2, and so on), and the Rule Order reflects this rule's place in the order.
    protocols List<String>
    Protocol for the given rule. This field is not applicable to the Lite API.
    rank Number
    (Integer) The admin rank specified for the rule based on your assigned admin rank. Admin rank determines the rule order that can be specified for the rule. Admin rank can be configured if it is enabled in the Advanced Settings.
    ruleId Number
    state String
    (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED
    urlCategories List<String>
    (List of Strings) The list of URL categories to which the DLP policy rule must be applied.
    users Property Map
    (List of Objects) You can manually select up to 4 general and/or special users. When not used it implies Any to apply the rule to all users.
    zpaAppSegments List<Property Map>
    (List of Objects) The ZPA application segments to which the rule applies

    Supporting Types

    SandboxRulesDepartments, SandboxRulesDepartmentsArgs

    Ids List<int>
    (Integer) Identifier that uniquely identifies an entity
    Ids []int
    (Integer) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Integer) Identifier that uniquely identifies an entity
    ids number[]
    (Integer) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Integer) Identifier that uniquely identifies an entity
    ids List<Number>
    (Integer) Identifier that uniquely identifies an entity

    SandboxRulesGroups, SandboxRulesGroupsArgs

    Ids List<int>
    (Integer) Identifier that uniquely identifies an entity
    Ids []int
    (Integer) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Integer) Identifier that uniquely identifies an entity
    ids number[]
    (Integer) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Integer) Identifier that uniquely identifies an entity
    ids List<Number>
    (Integer) Identifier that uniquely identifies an entity

    SandboxRulesLabels, SandboxRulesLabelsArgs

    Id int
    (Integer) Identifier that uniquely identifies an entity
    Id int
    (Integer) Identifier that uniquely identifies an entity
    id Integer
    (Integer) Identifier that uniquely identifies an entity
    id number
    (Integer) Identifier that uniquely identifies an entity
    id int
    (Integer) Identifier that uniquely identifies an entity
    id Number
    (Integer) Identifier that uniquely identifies an entity

    SandboxRulesLocationGroups, SandboxRulesLocationGroupsArgs

    Ids List<int>
    (Integer) Identifier that uniquely identifies an entity
    Ids []int
    (Integer) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Integer) Identifier that uniquely identifies an entity
    ids number[]
    (Integer) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Integer) Identifier that uniquely identifies an entity
    ids List<Number>
    (Integer) Identifier that uniquely identifies an entity

    SandboxRulesLocations, SandboxRulesLocationsArgs

    Ids List<int>
    (Integer) Identifier that uniquely identifies an entity
    Ids []int
    (Integer) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Integer) Identifier that uniquely identifies an entity
    ids number[]
    (Integer) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Integer) Identifier that uniquely identifies an entity
    ids List<Number>
    (Integer) Identifier that uniquely identifies an entity

    SandboxRulesUsers, SandboxRulesUsersArgs

    Ids List<int>
    (Integer) Identifier that uniquely identifies an entity
    Ids []int
    (Integer) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Integer) Identifier that uniquely identifies an entity
    ids number[]
    (Integer) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Integer) Identifier that uniquely identifies an entity
    ids List<Number>
    (Integer) Identifier that uniquely identifies an entity

    SandboxRulesZpaAppSegment, SandboxRulesZpaAppSegmentArgs

    ExternalId string
    External ID of the application segment.
    Name string
    Name of the application segment.
    ExternalId string
    External ID of the application segment.
    Name string
    Name of the application segment.
    externalId String
    External ID of the application segment.
    name String
    Name of the application segment.
    externalId string
    External ID of the application segment.
    name string
    Name of the application segment.
    external_id str
    External ID of the application segment.
    name str
    Name of the application segment.
    externalId String
    External ID of the application segment.
    name String
    Name of the application segment.

    Import

    Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.

    Visit

    zia_sandbox_rules can be imported by using <RULE ID> or <RULE NAME> as the import ID.

    For example:

    $ pulumi import zia:index/sandboxRules:SandboxRules example <rule_id>

    or

    $ pulumi import zia:index/sandboxRules:SandboxRules example <rule_name>

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
    zscaler/pulumi-zia