Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. PolicyInspectionRuleV2
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

zpa.PolicyInspectionRuleV2

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa
    Deprecated: zpa.index/policyinspectionrulev2.PolicyInspectionRuleV2 has been deprecated in favor of zpa.index/policyaccessinspectionrulev2.PolicyAccessInspectionRuleV2

    The zpa_policy_inspection_rule_v2 resource creates and manages policy access inspection rule in the Zscaler Private Access cloud using a new v2 API endpoint.

    ⚠️ NOTE: This resource is recommended if your configuration requires the association of more than 1000 resource criteria per rule.

    ⚠️ WARNING:: The attribute rule_order is now deprecated in favor of the new resource policy_access_rule_reorder

    Create PolicyInspectionRuleV2 Resource

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

    Constructor syntax

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

@overload
def PolicyInspectionRuleV2(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           action: Optional[str] = None,
                           conditions: Optional[Sequence[PolicyInspectionRuleV2ConditionArgs]] = None,
                           description: Optional[str] = None,
                           microtenant_id: Optional[str] = None,
                           name: Optional[str] = None,
                           zpn_inspection_profile_id: Optional[str] = None)
    func NewPolicyInspectionRuleV2(ctx *Context, name string, args *PolicyInspectionRuleV2Args, opts ...ResourceOption) (*PolicyInspectionRuleV2, error)
    public PolicyInspectionRuleV2(string name, PolicyInspectionRuleV2Args? args = null, CustomResourceOptions? opts = null)
    public PolicyInspectionRuleV2(String name, PolicyInspectionRuleV2Args args)
public PolicyInspectionRuleV2(String name, PolicyInspectionRuleV2Args args, CustomResourceOptions options)

    type: zpa:PolicyInspectionRuleV2
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 PolicyInspectionRuleV2Args
    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 PolicyInspectionRuleV2Args
    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 PolicyInspectionRuleV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyInspectionRuleV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyInspectionRuleV2Args
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Action string
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    Conditions List<Zscaler.Zpa.Inputs.PolicyInspectionRuleV2Condition>
    This is for proviidng the set of conditions for the policy.
    Description string
    This is the description of the access policy rule.
    MicrotenantId string
    Name string
    • (String) This is the name of the policy rule.
    ZpnInspectionProfileId string
    An inspection profile is required if the action is set to INSPECT
    Action string
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    Conditions []PolicyInspectionRuleV2ConditionArgs
    This is for proviidng the set of conditions for the policy.
    Description string
    This is the description of the access policy rule.
    MicrotenantId string
    Name string
    • (String) This is the name of the policy rule.
    ZpnInspectionProfileId string
    An inspection profile is required if the action is set to INSPECT
    action String
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions List<PolicyInspectionRuleV2Condition>
    This is for proviidng the set of conditions for the policy.
    description String
    This is the description of the access policy rule.
    microtenantId String
    name String
    • (String) This is the name of the policy rule.
    zpnInspectionProfileId String
    An inspection profile is required if the action is set to INSPECT
    action string
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions PolicyInspectionRuleV2Condition[]
    This is for proviidng the set of conditions for the policy.
    description string
    This is the description of the access policy rule.
    microtenantId string
    name string
    • (String) This is the name of the policy rule.
    zpnInspectionProfileId string
    An inspection profile is required if the action is set to INSPECT
    action str
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions Sequence[PolicyInspectionRuleV2ConditionArgs]
    This is for proviidng the set of conditions for the policy.
    description str
    This is the description of the access policy rule.
    microtenant_id str
    name str
    • (String) This is the name of the policy rule.
    zpn_inspection_profile_id str
    An inspection profile is required if the action is set to INSPECT
    action String
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions List<Property Map>
    This is for proviidng the set of conditions for the policy.
    description String
    This is the description of the access policy rule.
    microtenantId String
    name String
    • (String) This is the name of the policy rule.
    zpnInspectionProfileId String
    An inspection profile is required if the action is set to INSPECT

    Outputs

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

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

    Look up Existing PolicyInspectionRuleV2 Resource

    Get an existing PolicyInspectionRuleV2 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?: PolicyInspectionRuleV2State, opts?: CustomResourceOptions): PolicyInspectionRuleV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        conditions: Optional[Sequence[PolicyInspectionRuleV2ConditionArgs]] = None,
        description: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        policy_set_id: Optional[str] = None,
        zpn_inspection_profile_id: Optional[str] = None) -> PolicyInspectionRuleV2
    func GetPolicyInspectionRuleV2(ctx *Context, name string, id IDInput, state *PolicyInspectionRuleV2State, opts ...ResourceOption) (*PolicyInspectionRuleV2, error)
    public static PolicyInspectionRuleV2 Get(string name, Input<string> id, PolicyInspectionRuleV2State? state, CustomResourceOptions? opts = null)
    public static PolicyInspectionRuleV2 get(String name, Output<String> id, PolicyInspectionRuleV2State state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Action string
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    Conditions List<Zscaler.Zpa.Inputs.PolicyInspectionRuleV2Condition>
    This is for proviidng the set of conditions for the policy.
    Description string
    This is the description of the access policy rule.
    MicrotenantId string
    Name string
    • (String) This is the name of the policy rule.
    PolicySetId string
    ZpnInspectionProfileId string
    An inspection profile is required if the action is set to INSPECT
    Action string
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    Conditions []PolicyInspectionRuleV2ConditionArgs
    This is for proviidng the set of conditions for the policy.
    Description string
    This is the description of the access policy rule.
    MicrotenantId string
    Name string
    • (String) This is the name of the policy rule.
    PolicySetId string
    ZpnInspectionProfileId string
    An inspection profile is required if the action is set to INSPECT
    action String
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions List<PolicyInspectionRuleV2Condition>
    This is for proviidng the set of conditions for the policy.
    description String
    This is the description of the access policy rule.
    microtenantId String
    name String
    • (String) This is the name of the policy rule.
    policySetId String
    zpnInspectionProfileId String
    An inspection profile is required if the action is set to INSPECT
    action string
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions PolicyInspectionRuleV2Condition[]
    This is for proviidng the set of conditions for the policy.
    description string
    This is the description of the access policy rule.
    microtenantId string
    name string
    • (String) This is the name of the policy rule.
    policySetId string
    zpnInspectionProfileId string
    An inspection profile is required if the action is set to INSPECT
    action str
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions Sequence[PolicyInspectionRuleV2ConditionArgs]
    This is for proviidng the set of conditions for the policy.
    description str
    This is the description of the access policy rule.
    microtenant_id str
    name str
    • (String) This is the name of the policy rule.
    policy_set_id str
    zpn_inspection_profile_id str
    An inspection profile is required if the action is set to INSPECT
    action String
    This is for providing the rule action. Supported values: INSPECT and BYPASS_INSPECT.
    conditions List<Property Map>
    This is for proviidng the set of conditions for the policy.
    description String
    This is the description of the access policy rule.
    microtenantId String
    name String
    • (String) This is the name of the policy rule.
    policySetId String
    zpnInspectionProfileId String
    An inspection profile is required if the action is set to INSPECT

    Supporting Types

    PolicyInspectionRuleV2Condition, PolicyInspectionRuleV2ConditionArgs

    Id string
    Operands List<Zscaler.Zpa.Inputs.PolicyInspectionRuleV2ConditionOperand>
    This signifies the various policy criteria.
    Operator string
    Id string
    Operands []PolicyInspectionRuleV2ConditionOperand
    This signifies the various policy criteria.
    Operator string
    id String
    operands List<PolicyInspectionRuleV2ConditionOperand>
    This signifies the various policy criteria.
    operator String
    id string
    operands PolicyInspectionRuleV2ConditionOperand[]
    This signifies the various policy criteria.
    operator string
    id str
    operands Sequence[PolicyInspectionRuleV2ConditionOperand]
    This signifies the various policy criteria.
    operator str
    id String
    operands List<Property Map>
    This signifies the various policy criteria.
    operator String

    PolicyInspectionRuleV2ConditionOperand, PolicyInspectionRuleV2ConditionOperandArgs

    EntryValues List<Zscaler.Zpa.Inputs.PolicyInspectionRuleV2ConditionOperandEntryValue>
    ObjectType string
    This is for specifying the policy critiera.
    Values List<string>
    This denotes a list of values for the given object type. The value depend upon the key. If rhs is defined this list will be ignored
    EntryValues []PolicyInspectionRuleV2ConditionOperandEntryValue
    ObjectType string
    This is for specifying the policy critiera.
    Values []string
    This denotes a list of values for the given object type. The value depend upon the key. If rhs is defined this list will be ignored
    entryValues List<PolicyInspectionRuleV2ConditionOperandEntryValue>
    objectType String
    This is for specifying the policy critiera.
    values List<String>
    This denotes a list of values for the given object type. The value depend upon the key. If rhs is defined this list will be ignored
    entryValues PolicyInspectionRuleV2ConditionOperandEntryValue[]
    objectType string
    This is for specifying the policy critiera.
    values string[]
    This denotes a list of values for the given object type. The value depend upon the key. If rhs is defined this list will be ignored
    entry_values Sequence[PolicyInspectionRuleV2ConditionOperandEntryValue]
    object_type str
    This is for specifying the policy critiera.
    values Sequence[str]
    This denotes a list of values for the given object type. The value depend upon the key. If rhs is defined this list will be ignored
    entryValues List<Property Map>
    objectType String
    This is for specifying the policy critiera.
    values List<String>
    This denotes a list of values for the given object type. The value depend upon the key. If rhs is defined this list will be ignored

    PolicyInspectionRuleV2ConditionOperandEntryValue, PolicyInspectionRuleV2ConditionOperandEntryValueArgs

    Lhs string
    Rhs string
    Lhs string
    Rhs string
    lhs String
    rhs String
    lhs string
    rhs string
    lhs str
    rhs str
    lhs String
    rhs String

    Import

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

    Visit

    Policy access inspection rule can be imported by using <RULE ID> as the import ID.

    For example:

    $ pulumi import zpa:index/policyInspectionRuleV2:PolicyInspectionRuleV2 example <rule_id>

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

    Package Details

    Repository
    zpa zscaler/pulumi-zpa
    License
    MIT
    Notes
    This Pulumi package is based on the zpa Terraform Provider.
    zpa logo
    Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zpa