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. getSandboxRules
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

zia.getSandboxRules

Explore with Pulumi AI

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

    Use the zia_sandbox_rules data source to get information about a sandbox rule in the Zscaler Internet Access.

    Example Usage

    # ZIA Sandbox Rule by name
data "zia_sandbox_rules" "this" {
    name = "Default BA Rule"
}

    # ZIA Sandbox Rule by ID
data "zia_sandbox_rules" "this" {
    id = "12365478"
}

    Read-Only

    In addition to all arguments above, the following attributes are exported:

    • description - (String) Enter additional notes or information. The description cannot exceed 10,240 characters.

    • order - (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.

    • state - (String) The state of the rule indicating whether it is enabled or disabled. Supported values: ENABLED or DISABLED

    • rank - (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.

    • ba_rule_action - (String) The action configured for the rule that must take place if the traffic matches the rule criteria. Supported Values: ALLOW or BLOCK

    • first_time_enable - (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 - (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

    • ml_action_enabled - (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.

    • by_threat_score - (Integer)

    • default_rule - (Boolean) Value that indicates whether the rule is the Default Cloud IPS Rule or not

    • url_categories - (List of Strings) The list of URL categories to which the DLP policy rule must be applied.

    • file_types - (List of Strings) File type categories for which the policy is applied. If not set, the rule is applied across all file types.

    Who, Where and When supports the following attributes:

    • locations - (List of Objects) You can manually select up to 8 locations. When not used it implies Any to apply the rule to all groups.

      • id - (Integer) Identifier that uniquely identifies an entity

    • location_groups - (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.

      • id - (Integer) Identifier that uniquely identifies an entity

    • users - (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.

      • id - (Integer) Identifier that uniquely identifies an entity

    • groups - (List of Objects) You can manually select up to 8 groups. When not used it implies Any to apply the rule to all groups.

      • id - (Integer) Identifier that uniquely identifies an entity

    • departments - (List of Objects) Apply to any number of departments When not used it implies Any to apply the rule to all departments.

      • id - (Integer) Identifier that uniquely identifies an entity

    • labels (List of Objects) Labels that are applicable to the rule.

      • id - (Integer) Identifier that uniquely identifies an entity

    • zpa_app_segments (List of Objects) The ZPA application segments to which the rule applies

      • id - (Integer) Identifier that uniquely identifies an entity

    Using getSandboxRules

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSandboxRules(args: GetSandboxRulesArgs, opts?: InvokeOptions): Promise<GetSandboxRulesResult>
function getSandboxRulesOutput(args: GetSandboxRulesOutputArgs, opts?: InvokeOptions): Output<GetSandboxRulesResult>
    def get_sandbox_rules(id: Optional[int] = None,
                      name: Optional[str] = None,
                      url_categories: Optional[Sequence[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSandboxRulesResult
def get_sandbox_rules_output(id: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      url_categories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSandboxRulesResult]
    func LookupSandboxRules(ctx *Context, args *LookupSandboxRulesArgs, opts ...InvokeOption) (*LookupSandboxRulesResult, error)
func LookupSandboxRulesOutput(ctx *Context, args *LookupSandboxRulesOutputArgs, opts ...InvokeOption) LookupSandboxRulesResultOutput

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

    public static class GetSandboxRules 
{
    public static Task<GetSandboxRulesResult> InvokeAsync(GetSandboxRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetSandboxRulesResult> Invoke(GetSandboxRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSandboxRulesResult> getSandboxRules(GetSandboxRulesArgs args, InvokeOptions options)
public static Output<GetSandboxRulesResult> getSandboxRules(GetSandboxRulesArgs args, InvokeOptions options)

    fn::invoke:
  function: zia:index/getSandboxRules:getSandboxRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    UrlCategories List<string>
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    UrlCategories []string
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    urlCategories List<String>
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    urlCategories string[]
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    url_categories Sequence[str]
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    urlCategories List<String>

    getSandboxRules Result

    The following output properties are available:

    BaPolicyCategories List<string>
    BaRuleAction string
    ByThreatScore int
    Departments List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesDepartment>
    Description string
    FileTypes List<string>
    FirstTimeEnable bool
    FirstTimeOperation string
    Groups List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesGroup>
    Id int
    Labels List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesLabel>
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesLastModifiedBy>
    LastModifiedTime int
    LocationGroups List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesLocationGroup>
    Locations List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesLocation>
    MlActionEnabled bool
    Name string
    Order int
    Protocols List<string>
    Rank int
    State string
    Users List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesUser>
    ZpaAppSegments List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxRulesZpaAppSegment>
    UrlCategories List<string>

    Supporting Types

    GetSandboxRulesDepartment

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesGroup

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesLabel

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesLastModifiedBy

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesLocation

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesLocationGroup

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesUser

    Extensions Dictionary<string, string>
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    Extensions map[string]string
    Additional information about the entity
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    extensions Map<String,String>
    Additional information about the entity
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    extensions {[key: string]: string}
    Additional information about the entity
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    extensions Mapping[str, str]
    Additional information about the entity
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    extensions Map<String>
    Additional information about the entity
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    GetSandboxRulesZpaAppSegment

    ExternalId string
    Indicates the external ID. Applicable only when this reference is of an external entity.
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    ExternalId string
    Indicates the external ID. Applicable only when this reference is of an external entity.
    Id int
    Unique identifier for the Sandbox rule
    Name string
    Name of the Sandbox rule
    externalId String
    Indicates the external ID. Applicable only when this reference is of an external entity.
    id Integer
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule
    externalId string
    Indicates the external ID. Applicable only when this reference is of an external entity.
    id number
    Unique identifier for the Sandbox rule
    name string
    Name of the Sandbox rule
    external_id str
    Indicates the external ID. Applicable only when this reference is of an external entity.
    id int
    Unique identifier for the Sandbox rule
    name str
    Name of the Sandbox rule
    externalId String
    Indicates the external ID. Applicable only when this reference is of an external entity.
    id Number
    Unique identifier for the Sandbox rule
    name String
    Name of the Sandbox rule

    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