1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. PolicyCredentialRule
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

zpa.PolicyCredentialRule

Explore with Pulumi AI

Deprecated: zpa.index/policycredentialrule.PolicyCredentialRule has been deprecated in favor of zpa.index/policyaccesscredentialrule.PolicyAccessCredentialRule

Create PolicyCredentialRule Resource

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

Constructor syntax

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

@overload
def PolicyCredentialRule(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         action: Optional[str] = None,
                         conditions: Optional[Sequence[PolicyCredentialRuleConditionArgs]] = None,
                         credentials: Optional[Sequence[PolicyCredentialRuleCredentialArgs]] = None,
                         description: Optional[str] = None,
                         microtenant_id: Optional[str] = None,
                         name: Optional[str] = None)
func NewPolicyCredentialRule(ctx *Context, name string, args *PolicyCredentialRuleArgs, opts ...ResourceOption) (*PolicyCredentialRule, error)
public PolicyCredentialRule(string name, PolicyCredentialRuleArgs? args = null, CustomResourceOptions? opts = null)
public PolicyCredentialRule(String name, PolicyCredentialRuleArgs args)
public PolicyCredentialRule(String name, PolicyCredentialRuleArgs args, CustomResourceOptions options)
type: zpa:PolicyCredentialRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

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

Action string
This is for providing the rule action.
Conditions List<Zscaler.Zpa.Inputs.PolicyCredentialRuleCondition>
This is for proviidng the set of conditions for the policy.
Credentials List<Zscaler.Zpa.Inputs.PolicyCredentialRuleCredential>
Description string
This is the description of the access policy.
MicrotenantId string
Name string
This is the name of the policy.
Action string
This is for providing the rule action.
Conditions []PolicyCredentialRuleConditionArgs
This is for proviidng the set of conditions for the policy.
Credentials []PolicyCredentialRuleCredentialArgs
Description string
This is the description of the access policy.
MicrotenantId string
Name string
This is the name of the policy.
action String
This is for providing the rule action.
conditions List<PolicyCredentialRuleCondition>
This is for proviidng the set of conditions for the policy.
credentials List<PolicyCredentialRuleCredential>
description String
This is the description of the access policy.
microtenantId String
name String
This is the name of the policy.
action string
This is for providing the rule action.
conditions PolicyCredentialRuleCondition[]
This is for proviidng the set of conditions for the policy.
credentials PolicyCredentialRuleCredential[]
description string
This is the description of the access policy.
microtenantId string
name string
This is the name of the policy.
action str
This is for providing the rule action.
conditions Sequence[PolicyCredentialRuleConditionArgs]
This is for proviidng the set of conditions for the policy.
credentials Sequence[PolicyCredentialRuleCredentialArgs]
description str
This is the description of the access policy.
microtenant_id str
name str
This is the name of the policy.
action String
This is for providing the rule action.
conditions List<Property Map>
This is for proviidng the set of conditions for the policy.
credentials List<Property Map>
description String
This is the description of the access policy.
microtenantId String
name String
This is the name of the policy.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyCredentialRule 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 PolicyCredentialRule Resource

Get an existing PolicyCredentialRule 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?: PolicyCredentialRuleState, opts?: CustomResourceOptions): PolicyCredentialRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        conditions: Optional[Sequence[PolicyCredentialRuleConditionArgs]] = None,
        credentials: Optional[Sequence[PolicyCredentialRuleCredentialArgs]] = None,
        description: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        policy_set_id: Optional[str] = None) -> PolicyCredentialRule
func GetPolicyCredentialRule(ctx *Context, name string, id IDInput, state *PolicyCredentialRuleState, opts ...ResourceOption) (*PolicyCredentialRule, error)
public static PolicyCredentialRule Get(string name, Input<string> id, PolicyCredentialRuleState? state, CustomResourceOptions? opts = null)
public static PolicyCredentialRule get(String name, Output<String> id, PolicyCredentialRuleState state, CustomResourceOptions options)
resources:  _:    type: zpa:PolicyCredentialRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
Conditions List<Zscaler.Zpa.Inputs.PolicyCredentialRuleCondition>
This is for proviidng the set of conditions for the policy.
Credentials List<Zscaler.Zpa.Inputs.PolicyCredentialRuleCredential>
Description string
This is the description of the access policy.
MicrotenantId string
Name string
This is the name of the policy.
PolicySetId string
Action string
This is for providing the rule action.
Conditions []PolicyCredentialRuleConditionArgs
This is for proviidng the set of conditions for the policy.
Credentials []PolicyCredentialRuleCredentialArgs
Description string
This is the description of the access policy.
MicrotenantId string
Name string
This is the name of the policy.
PolicySetId string
action String
This is for providing the rule action.
conditions List<PolicyCredentialRuleCondition>
This is for proviidng the set of conditions for the policy.
credentials List<PolicyCredentialRuleCredential>
description String
This is the description of the access policy.
microtenantId String
name String
This is the name of the policy.
policySetId String
action string
This is for providing the rule action.
conditions PolicyCredentialRuleCondition[]
This is for proviidng the set of conditions for the policy.
credentials PolicyCredentialRuleCredential[]
description string
This is the description of the access policy.
microtenantId string
name string
This is the name of the policy.
policySetId string
action str
This is for providing the rule action.
conditions Sequence[PolicyCredentialRuleConditionArgs]
This is for proviidng the set of conditions for the policy.
credentials Sequence[PolicyCredentialRuleCredentialArgs]
description str
This is the description of the access policy.
microtenant_id str
name str
This is the name of the policy.
policy_set_id str
action String
This is for providing the rule action.
conditions List<Property Map>
This is for proviidng the set of conditions for the policy.
credentials List<Property Map>
description String
This is the description of the access policy.
microtenantId String
name String
This is the name of the policy.
policySetId String

Supporting Types

PolicyCredentialRuleCondition
, PolicyCredentialRuleConditionArgs

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

PolicyCredentialRuleConditionOperand
, PolicyCredentialRuleConditionOperandArgs

EntryValues List<Zscaler.Zpa.Inputs.PolicyCredentialRuleConditionOperandEntryValue>
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 []PolicyCredentialRuleConditionOperandEntryValue
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<PolicyCredentialRuleConditionOperandEntryValue>
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 PolicyCredentialRuleConditionOperandEntryValue[]
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[PolicyCredentialRuleConditionOperandEntryValue]
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

PolicyCredentialRuleConditionOperandEntryValue
, PolicyCredentialRuleConditionOperandEntryValueArgs

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

PolicyCredentialRuleCredential
, PolicyCredentialRuleCredentialArgs

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

Package Details

Repository
zpa zscaler/pulumi-zpa
License
MIT
Notes
This Pulumi package is based on the zpa Terraform Provider.