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

zpa.PolicyAccessCredentialRule

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

    Create PolicyAccessCredentialRule Resource

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

    Constructor syntax

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

@overload
def PolicyAccessCredentialRule(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               action: Optional[str] = None,
                               conditions: Optional[Sequence[PolicyAccessCredentialRuleConditionArgs]] = None,
                               credentials: Optional[Sequence[PolicyAccessCredentialRuleCredentialArgs]] = None,
                               description: Optional[str] = None,
                               microtenant_id: Optional[str] = None,
                               name: Optional[str] = None)
    func NewPolicyAccessCredentialRule(ctx *Context, name string, args *PolicyAccessCredentialRuleArgs, opts ...ResourceOption) (*PolicyAccessCredentialRule, error)
    public PolicyAccessCredentialRule(string name, PolicyAccessCredentialRuleArgs? args = null, CustomResourceOptions? opts = null)
    public PolicyAccessCredentialRule(String name, PolicyAccessCredentialRuleArgs args)
public PolicyAccessCredentialRule(String name, PolicyAccessCredentialRuleArgs args, CustomResourceOptions options)

    type: zpa:PolicyAccessCredentialRule
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 PolicyAccessCredentialRuleArgs
    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 PolicyAccessCredentialRuleArgs
    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 PolicyAccessCredentialRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyAccessCredentialRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyAccessCredentialRuleArgs
    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 policyAccessCredentialRuleResource = new Zpa.PolicyAccessCredentialRule("policyAccessCredentialRuleResource", new()
{
    Action = "string",
    Conditions = new[]
    {
        new Zpa.Inputs.PolicyAccessCredentialRuleConditionArgs
        {
            Id = "string",
            Operands = new[]
            {
                new Zpa.Inputs.PolicyAccessCredentialRuleConditionOperandArgs
                {
                    EntryValues = new[]
                    {
                        new Zpa.Inputs.PolicyAccessCredentialRuleConditionOperandEntryValueArgs
                        {
                            Lhs = "string",
                            Rhs = "string",
                        },
                    },
                    ObjectType = "string",
                    Values = new[]
                    {
                        "string",
                    },
                },
            },
            Operator = "string",
        },
    },
    Credentials = new[]
    {
        new Zpa.Inputs.PolicyAccessCredentialRuleCredentialArgs
        {
            Id = "string",
        },
    },
    Description = "string",
    MicrotenantId = "string",
    Name = "string",
});

    example, err := zpa.NewPolicyAccessCredentialRule(ctx, "policyAccessCredentialRuleResource", &zpa.PolicyAccessCredentialRuleArgs{
	Action: pulumi.String("string"),
	Conditions: zpa.PolicyAccessCredentialRuleConditionArray{
		&zpa.PolicyAccessCredentialRuleConditionArgs{
			Id: pulumi.String("string"),
			Operands: zpa.PolicyAccessCredentialRuleConditionOperandArray{
				&zpa.PolicyAccessCredentialRuleConditionOperandArgs{
					EntryValues: zpa.PolicyAccessCredentialRuleConditionOperandEntryValueArray{
						&zpa.PolicyAccessCredentialRuleConditionOperandEntryValueArgs{
							Lhs: pulumi.String("string"),
							Rhs: pulumi.String("string"),
						},
					},
					ObjectType: pulumi.String("string"),
					Values: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			Operator: pulumi.String("string"),
		},
	},
	Credentials: zpa.PolicyAccessCredentialRuleCredentialArray{
		&zpa.PolicyAccessCredentialRuleCredentialArgs{
			Id: pulumi.String("string"),
		},
	},
	Description:   pulumi.String("string"),
	MicrotenantId: pulumi.String("string"),
	Name:          pulumi.String("string"),
})

    var policyAccessCredentialRuleResource = new PolicyAccessCredentialRule("policyAccessCredentialRuleResource", PolicyAccessCredentialRuleArgs.builder()
    .action("string")
    .conditions(PolicyAccessCredentialRuleConditionArgs.builder()
        .id("string")
        .operands(PolicyAccessCredentialRuleConditionOperandArgs.builder()
            .entryValues(PolicyAccessCredentialRuleConditionOperandEntryValueArgs.builder()
                .lhs("string")
                .rhs("string")
                .build())
            .objectType("string")
            .values("string")
            .build())
        .operator("string")
        .build())
    .credentials(PolicyAccessCredentialRuleCredentialArgs.builder()
        .id("string")
        .build())
    .description("string")
    .microtenantId("string")
    .name("string")
    .build());

    policy_access_credential_rule_resource = zpa.PolicyAccessCredentialRule("policyAccessCredentialRuleResource",
    action="string",
    conditions=[zpa.PolicyAccessCredentialRuleConditionArgs(
        id="string",
        operands=[zpa.PolicyAccessCredentialRuleConditionOperandArgs(
            entry_values=[zpa.PolicyAccessCredentialRuleConditionOperandEntryValueArgs(
                lhs="string",
                rhs="string",
            )],
            object_type="string",
            values=["string"],
        )],
        operator="string",
    )],
    credentials=[zpa.PolicyAccessCredentialRuleCredentialArgs(
        id="string",
    )],
    description="string",
    microtenant_id="string",
    name="string")

    const policyAccessCredentialRuleResource = new zpa.PolicyAccessCredentialRule("policyAccessCredentialRuleResource", {
    action: "string",
    conditions: [{
        id: "string",
        operands: [{
            entryValues: [{
                lhs: "string",
                rhs: "string",
            }],
            objectType: "string",
            values: ["string"],
        }],
        operator: "string",
    }],
    credentials: [{
        id: "string",
    }],
    description: "string",
    microtenantId: "string",
    name: "string",
});

    type: zpa:PolicyAccessCredentialRule
properties:
    action: string
    conditions:
        - id: string
          operands:
            - entryValues:
                - lhs: string
                  rhs: string
              objectType: string
              values:
                - string
          operator: string
    credentials:
        - id: string
    description: string
    microtenantId: string
    name: string

    PolicyAccessCredentialRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PolicyAccessCredentialRule resource accepts the following input properties:

    Action string
    This is for providing the rule action.
    Conditions List<Zscaler.Zpa.Inputs.PolicyAccessCredentialRuleCondition>
    This is for proviidng the set of conditions for the policy.
    Credentials List<Zscaler.Zpa.Inputs.PolicyAccessCredentialRuleCredential>
    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 []PolicyAccessCredentialRuleConditionArgs
    This is for proviidng the set of conditions for the policy.
    Credentials []PolicyAccessCredentialRuleCredentialArgs
    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<PolicyAccessCredentialRuleCondition>
    This is for proviidng the set of conditions for the policy.
    credentials List<PolicyAccessCredentialRuleCredential>
    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 PolicyAccessCredentialRuleCondition[]
    This is for proviidng the set of conditions for the policy.
    credentials PolicyAccessCredentialRuleCredential[]
    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[PolicyAccessCredentialRuleConditionArgs]
    This is for proviidng the set of conditions for the policy.
    credentials Sequence[PolicyAccessCredentialRuleCredentialArgs]
    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 PolicyAccessCredentialRule 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 PolicyAccessCredentialRule Resource

    Get an existing PolicyAccessCredentialRule 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?: PolicyAccessCredentialRuleState, opts?: CustomResourceOptions): PolicyAccessCredentialRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        conditions: Optional[Sequence[PolicyAccessCredentialRuleConditionArgs]] = None,
        credentials: Optional[Sequence[PolicyAccessCredentialRuleCredentialArgs]] = None,
        description: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        policy_set_id: Optional[str] = None) -> PolicyAccessCredentialRule
    func GetPolicyAccessCredentialRule(ctx *Context, name string, id IDInput, state *PolicyAccessCredentialRuleState, opts ...ResourceOption) (*PolicyAccessCredentialRule, error)
    public static PolicyAccessCredentialRule Get(string name, Input<string> id, PolicyAccessCredentialRuleState? state, CustomResourceOptions? opts = null)
    public static PolicyAccessCredentialRule get(String name, Output<String> id, PolicyAccessCredentialRuleState 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.
    Conditions List<Zscaler.Zpa.Inputs.PolicyAccessCredentialRuleCondition>
    This is for proviidng the set of conditions for the policy.
    Credentials List<Zscaler.Zpa.Inputs.PolicyAccessCredentialRuleCredential>
    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 []PolicyAccessCredentialRuleConditionArgs
    This is for proviidng the set of conditions for the policy.
    Credentials []PolicyAccessCredentialRuleCredentialArgs
    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<PolicyAccessCredentialRuleCondition>
    This is for proviidng the set of conditions for the policy.
    credentials List<PolicyAccessCredentialRuleCredential>
    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 PolicyAccessCredentialRuleCondition[]
    This is for proviidng the set of conditions for the policy.
    credentials PolicyAccessCredentialRuleCredential[]
    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[PolicyAccessCredentialRuleConditionArgs]
    This is for proviidng the set of conditions for the policy.
    credentials Sequence[PolicyAccessCredentialRuleCredentialArgs]
    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

    PolicyAccessCredentialRuleCondition, PolicyAccessCredentialRuleConditionArgs

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

    PolicyAccessCredentialRuleConditionOperand, PolicyAccessCredentialRuleConditionOperandArgs

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

    PolicyAccessCredentialRuleConditionOperandEntryValue, PolicyAccessCredentialRuleConditionOperandEntryValueArgs

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

    PolicyAccessCredentialRuleCredential, PolicyAccessCredentialRuleCredentialArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    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