1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. NatControlRules
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler

zia.NatControlRules

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler

    The zia_nat_control_rules resource allows the creation and management of NAT Control rules in the Zscaler Internet Access.

    Example Usage

    resource "zia_nat_control_rules" "this" {
        name = "DNAT_02"
        description = "DNAT_02"
        order=1
        rank=7
        state = "ENABLED"
        redirect_port="2000"
        redirect_ip="1.1.1.1"
        src_ips=["192.168.100.0/24", "192.168.200.1"]
        dest_addresses=["3.217.228.0-3.217.231.255", "3.235.112.0-3.235.119.255", "35.80.88.0-35.80.95.255", "server1.acme.com", "*.acme.com"]
        dest_countries=["BR", "CA", "GB"]
      departments {
        id = [8061246]
      }
      dest_ip_groups {
        id = [-4]
      }
      dest_ipv6_groups {
        id = [-5]
      }
      src_ip_groups {
        id = [18448894]
      }
      src_ipv6_groups {
        id = [-3]
      }
      time_windows {
        id = [485]
      }
      nw_services {
        id = [462370, 17472664]
      }
      locations {
        id = [256000852, -3]
      }
      location_groups {
        id = [8061257, 8061256]
      }
      labels {
        id = [1416803]
      }
    }
    

    Create NatControlRules Resource

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

    Constructor syntax

    new NatControlRules(name: string, args?: NatControlRulesArgs, opts?: CustomResourceOptions);
    @overload
    def NatControlRules(resource_name: str,
                        args: Optional[NatControlRulesArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def NatControlRules(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        default_rule: Optional[bool] = None,
                        departments: Optional[NatControlRulesDepartmentsArgs] = None,
                        description: Optional[str] = None,
                        dest_addresses: Optional[Sequence[str]] = None,
                        dest_countries: Optional[Sequence[str]] = None,
                        dest_ip_categories: Optional[Sequence[str]] = None,
                        dest_ip_groups: Optional[NatControlRulesDestIpGroupsArgs] = None,
                        dest_ipv6_groups: Optional[NatControlRulesDestIpv6GroupsArgs] = None,
                        device_groups: Optional[NatControlRulesDeviceGroupsArgs] = None,
                        devices: Optional[NatControlRulesDevicesArgs] = None,
                        enable_full_logging: Optional[bool] = None,
                        groups: Optional[NatControlRulesGroupsArgs] = None,
                        labels: Optional[NatControlRulesLabelsArgs] = None,
                        location_groups: Optional[NatControlRulesLocationGroupsArgs] = None,
                        locations: Optional[NatControlRulesLocationsArgs] = None,
                        name: Optional[str] = None,
                        nw_service_groups: Optional[NatControlRulesNwServiceGroupsArgs] = None,
                        nw_services: Optional[NatControlRulesNwServicesArgs] = None,
                        order: Optional[int] = None,
                        predefined: Optional[bool] = None,
                        rank: Optional[int] = None,
                        redirect_fqdn: Optional[str] = None,
                        redirect_ip: Optional[str] = None,
                        redirect_port: Optional[int] = None,
                        res_categories: Optional[Sequence[str]] = None,
                        src_ip_groups: Optional[NatControlRulesSrcIpGroupsArgs] = None,
                        src_ips: Optional[Sequence[str]] = None,
                        src_ipv6_groups: Optional[NatControlRulesSrcIpv6GroupsArgs] = None,
                        state: Optional[str] = None,
                        time_windows: Optional[NatControlRulesTimeWindowsArgs] = None,
                        users: Optional[NatControlRulesUsersArgs] = None)
    func NewNatControlRules(ctx *Context, name string, args *NatControlRulesArgs, opts ...ResourceOption) (*NatControlRules, error)
    public NatControlRules(string name, NatControlRulesArgs? args = null, CustomResourceOptions? opts = null)
    public NatControlRules(String name, NatControlRulesArgs args)
    public NatControlRules(String name, NatControlRulesArgs args, CustomResourceOptions options)
    
    type: zia:NatControlRules
    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 NatControlRulesArgs
    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 NatControlRulesArgs
    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 NatControlRulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NatControlRulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NatControlRulesArgs
    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 natControlRulesResource = new Zia.NatControlRules("natControlRulesResource", new()
    {
        DefaultRule = false,
        Departments = new Zia.Inputs.NatControlRulesDepartmentsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Description = "string",
        DestAddresses = new[]
        {
            "string",
        },
        DestCountries = new[]
        {
            "string",
        },
        DestIpCategories = new[]
        {
            "string",
        },
        DestIpGroups = new Zia.Inputs.NatControlRulesDestIpGroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        DestIpv6Groups = new Zia.Inputs.NatControlRulesDestIpv6GroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        DeviceGroups = new Zia.Inputs.NatControlRulesDeviceGroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Devices = new Zia.Inputs.NatControlRulesDevicesArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        EnableFullLogging = false,
        Groups = new Zia.Inputs.NatControlRulesGroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Labels = new Zia.Inputs.NatControlRulesLabelsArgs
        {
            Id = 0,
        },
        LocationGroups = new Zia.Inputs.NatControlRulesLocationGroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Locations = new Zia.Inputs.NatControlRulesLocationsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Name = "string",
        NwServiceGroups = new Zia.Inputs.NatControlRulesNwServiceGroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        NwServices = new Zia.Inputs.NatControlRulesNwServicesArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Order = 0,
        Predefined = false,
        Rank = 0,
        RedirectFqdn = "string",
        RedirectIp = "string",
        RedirectPort = 0,
        ResCategories = new[]
        {
            "string",
        },
        SrcIpGroups = new Zia.Inputs.NatControlRulesSrcIpGroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        SrcIps = new[]
        {
            "string",
        },
        SrcIpv6Groups = new Zia.Inputs.NatControlRulesSrcIpv6GroupsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        State = "string",
        TimeWindows = new Zia.Inputs.NatControlRulesTimeWindowsArgs
        {
            Ids = new[]
            {
                0,
            },
        },
        Users = new Zia.Inputs.NatControlRulesUsersArgs
        {
            Ids = new[]
            {
                0,
            },
        },
    });
    
    example, err := zia.NewNatControlRules(ctx, "natControlRulesResource", &zia.NatControlRulesArgs{
    	DefaultRule: pulumi.Bool(false),
    	Departments: &zia.NatControlRulesDepartmentsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Description: pulumi.String("string"),
    	DestAddresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DestCountries: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DestIpCategories: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DestIpGroups: &zia.NatControlRulesDestIpGroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	DestIpv6Groups: &zia.NatControlRulesDestIpv6GroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	DeviceGroups: &zia.NatControlRulesDeviceGroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Devices: &zia.NatControlRulesDevicesArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	EnableFullLogging: pulumi.Bool(false),
    	Groups: &zia.NatControlRulesGroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Labels: &zia.NatControlRulesLabelsArgs{
    		Id: pulumi.Int(0),
    	},
    	LocationGroups: &zia.NatControlRulesLocationGroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Locations: &zia.NatControlRulesLocationsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Name: pulumi.String("string"),
    	NwServiceGroups: &zia.NatControlRulesNwServiceGroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	NwServices: &zia.NatControlRulesNwServicesArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Order:        pulumi.Int(0),
    	Predefined:   pulumi.Bool(false),
    	Rank:         pulumi.Int(0),
    	RedirectFqdn: pulumi.String("string"),
    	RedirectIp:   pulumi.String("string"),
    	RedirectPort: pulumi.Int(0),
    	ResCategories: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SrcIpGroups: &zia.NatControlRulesSrcIpGroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	SrcIps: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SrcIpv6Groups: &zia.NatControlRulesSrcIpv6GroupsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	State: pulumi.String("string"),
    	TimeWindows: &zia.NatControlRulesTimeWindowsArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    	Users: &zia.NatControlRulesUsersArgs{
    		Ids: pulumi.IntArray{
    			pulumi.Int(0),
    		},
    	},
    })
    
    var natControlRulesResource = new NatControlRules("natControlRulesResource", NatControlRulesArgs.builder()
        .defaultRule(false)
        .departments(NatControlRulesDepartmentsArgs.builder()
            .ids(0)
            .build())
        .description("string")
        .destAddresses("string")
        .destCountries("string")
        .destIpCategories("string")
        .destIpGroups(NatControlRulesDestIpGroupsArgs.builder()
            .ids(0)
            .build())
        .destIpv6Groups(NatControlRulesDestIpv6GroupsArgs.builder()
            .ids(0)
            .build())
        .deviceGroups(NatControlRulesDeviceGroupsArgs.builder()
            .ids(0)
            .build())
        .devices(NatControlRulesDevicesArgs.builder()
            .ids(0)
            .build())
        .enableFullLogging(false)
        .groups(NatControlRulesGroupsArgs.builder()
            .ids(0)
            .build())
        .labels(NatControlRulesLabelsArgs.builder()
            .id(0)
            .build())
        .locationGroups(NatControlRulesLocationGroupsArgs.builder()
            .ids(0)
            .build())
        .locations(NatControlRulesLocationsArgs.builder()
            .ids(0)
            .build())
        .name("string")
        .nwServiceGroups(NatControlRulesNwServiceGroupsArgs.builder()
            .ids(0)
            .build())
        .nwServices(NatControlRulesNwServicesArgs.builder()
            .ids(0)
            .build())
        .order(0)
        .predefined(false)
        .rank(0)
        .redirectFqdn("string")
        .redirectIp("string")
        .redirectPort(0)
        .resCategories("string")
        .srcIpGroups(NatControlRulesSrcIpGroupsArgs.builder()
            .ids(0)
            .build())
        .srcIps("string")
        .srcIpv6Groups(NatControlRulesSrcIpv6GroupsArgs.builder()
            .ids(0)
            .build())
        .state("string")
        .timeWindows(NatControlRulesTimeWindowsArgs.builder()
            .ids(0)
            .build())
        .users(NatControlRulesUsersArgs.builder()
            .ids(0)
            .build())
        .build());
    
    nat_control_rules_resource = zia.NatControlRules("natControlRulesResource",
        default_rule=False,
        departments={
            "ids": [0],
        },
        description="string",
        dest_addresses=["string"],
        dest_countries=["string"],
        dest_ip_categories=["string"],
        dest_ip_groups={
            "ids": [0],
        },
        dest_ipv6_groups={
            "ids": [0],
        },
        device_groups={
            "ids": [0],
        },
        devices={
            "ids": [0],
        },
        enable_full_logging=False,
        groups={
            "ids": [0],
        },
        labels={
            "id": 0,
        },
        location_groups={
            "ids": [0],
        },
        locations={
            "ids": [0],
        },
        name="string",
        nw_service_groups={
            "ids": [0],
        },
        nw_services={
            "ids": [0],
        },
        order=0,
        predefined=False,
        rank=0,
        redirect_fqdn="string",
        redirect_ip="string",
        redirect_port=0,
        res_categories=["string"],
        src_ip_groups={
            "ids": [0],
        },
        src_ips=["string"],
        src_ipv6_groups={
            "ids": [0],
        },
        state="string",
        time_windows={
            "ids": [0],
        },
        users={
            "ids": [0],
        })
    
    const natControlRulesResource = new zia.NatControlRules("natControlRulesResource", {
        defaultRule: false,
        departments: {
            ids: [0],
        },
        description: "string",
        destAddresses: ["string"],
        destCountries: ["string"],
        destIpCategories: ["string"],
        destIpGroups: {
            ids: [0],
        },
        destIpv6Groups: {
            ids: [0],
        },
        deviceGroups: {
            ids: [0],
        },
        devices: {
            ids: [0],
        },
        enableFullLogging: false,
        groups: {
            ids: [0],
        },
        labels: {
            id: 0,
        },
        locationGroups: {
            ids: [0],
        },
        locations: {
            ids: [0],
        },
        name: "string",
        nwServiceGroups: {
            ids: [0],
        },
        nwServices: {
            ids: [0],
        },
        order: 0,
        predefined: false,
        rank: 0,
        redirectFqdn: "string",
        redirectIp: "string",
        redirectPort: 0,
        resCategories: ["string"],
        srcIpGroups: {
            ids: [0],
        },
        srcIps: ["string"],
        srcIpv6Groups: {
            ids: [0],
        },
        state: "string",
        timeWindows: {
            ids: [0],
        },
        users: {
            ids: [0],
        },
    });
    
    type: zia:NatControlRules
    properties:
        defaultRule: false
        departments:
            ids:
                - 0
        description: string
        destAddresses:
            - string
        destCountries:
            - string
        destIpCategories:
            - string
        destIpGroups:
            ids:
                - 0
        destIpv6Groups:
            ids:
                - 0
        deviceGroups:
            ids:
                - 0
        devices:
            ids:
                - 0
        enableFullLogging: false
        groups:
            ids:
                - 0
        labels:
            id: 0
        locationGroups:
            ids:
                - 0
        locations:
            ids:
                - 0
        name: string
        nwServiceGroups:
            ids:
                - 0
        nwServices:
            ids:
                - 0
        order: 0
        predefined: false
        rank: 0
        redirectFqdn: string
        redirectIp: string
        redirectPort: 0
        resCategories:
            - string
        srcIpGroups:
            ids:
                - 0
        srcIps:
            - string
        srcIpv6Groups:
            ids:
                - 0
        state: string
        timeWindows:
            ids:
                - 0
        users:
            ids:
                - 0
    

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

    DefaultRule bool
    If set to true, the default rule is applied
    Departments zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDepartments
    list of departments for which rule must be applied
    Description string
    Additional information about the rule
    DestAddresses List<string>
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    DestCountries List<string>
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    DestIpCategories List<string>
    DestIpGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDestIpGroups
    list of destination ip groups
    DestIpv6Groups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDestIpv6Groups
    list of destination ipv6 groups
    DeviceGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDeviceGroups
    This field is applicable for devices that are managed using Zscaler Client Connector.
    Devices zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDevices
    Name-ID pairs of devices for which rule must be applied.
    EnableFullLogging bool
    Groups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesGroups
    list of groups for which rule must be applied
    Labels zscaler.PulumiPackage.Zia.Inputs.NatControlRulesLabels
    list of Labels that are applicable to the rule.
    LocationGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesLocationGroups
    list of locations groups
    Locations zscaler.PulumiPackage.Zia.Inputs.NatControlRulesLocations
    list of locations for which rule must be applied
    Name string
    Name of the nat control policy rule
    NwServiceGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesNwServiceGroups
    list of nw service groups
    NwServices zscaler.PulumiPackage.Zia.Inputs.NatControlRulesNwServices
    list of nw services
    Order int
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    Predefined bool
    If set to true, a predefined rule is applied
    Rank int
    Admin rank of the nat control policy rule
    RedirectFqdn string
    The action the nat control policy rule takes when packets match the rule
    RedirectIp string
    The action the nat control policy rule takes when packets match the rule
    RedirectPort int
    The action the nat control policy rule takes when packets match the rule
    ResCategories List<string>
    List of destination domain categories to which the rule applies
    SrcIpGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesSrcIpGroups
    list of source ip groups
    SrcIps List<string>
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    SrcIpv6Groups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesSrcIpv6Groups
    list of source ipv6 groups
    State string
    Determines whether the nat control policy rule is enabled or disabled
    TimeWindows zscaler.PulumiPackage.Zia.Inputs.NatControlRulesTimeWindows
    The time interval in which the nat control policy rule applies
    Users zscaler.PulumiPackage.Zia.Inputs.NatControlRulesUsers
    list of users for which rule must be applied
    DefaultRule bool
    If set to true, the default rule is applied
    Departments NatControlRulesDepartmentsArgs
    list of departments for which rule must be applied
    Description string
    Additional information about the rule
    DestAddresses []string
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    DestCountries []string
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    DestIpCategories []string
    DestIpGroups NatControlRulesDestIpGroupsArgs
    list of destination ip groups
    DestIpv6Groups NatControlRulesDestIpv6GroupsArgs
    list of destination ipv6 groups
    DeviceGroups NatControlRulesDeviceGroupsArgs
    This field is applicable for devices that are managed using Zscaler Client Connector.
    Devices NatControlRulesDevicesArgs
    Name-ID pairs of devices for which rule must be applied.
    EnableFullLogging bool
    Groups NatControlRulesGroupsArgs
    list of groups for which rule must be applied
    Labels NatControlRulesLabelsArgs
    list of Labels that are applicable to the rule.
    LocationGroups NatControlRulesLocationGroupsArgs
    list of locations groups
    Locations NatControlRulesLocationsArgs
    list of locations for which rule must be applied
    Name string
    Name of the nat control policy rule
    NwServiceGroups NatControlRulesNwServiceGroupsArgs
    list of nw service groups
    NwServices NatControlRulesNwServicesArgs
    list of nw services
    Order int
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    Predefined bool
    If set to true, a predefined rule is applied
    Rank int
    Admin rank of the nat control policy rule
    RedirectFqdn string
    The action the nat control policy rule takes when packets match the rule
    RedirectIp string
    The action the nat control policy rule takes when packets match the rule
    RedirectPort int
    The action the nat control policy rule takes when packets match the rule
    ResCategories []string
    List of destination domain categories to which the rule applies
    SrcIpGroups NatControlRulesSrcIpGroupsArgs
    list of source ip groups
    SrcIps []string
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    SrcIpv6Groups NatControlRulesSrcIpv6GroupsArgs
    list of source ipv6 groups
    State string
    Determines whether the nat control policy rule is enabled or disabled
    TimeWindows NatControlRulesTimeWindowsArgs
    The time interval in which the nat control policy rule applies
    Users NatControlRulesUsersArgs
    list of users for which rule must be applied
    defaultRule Boolean
    If set to true, the default rule is applied
    departments NatControlRulesDepartments
    list of departments for which rule must be applied
    description String
    Additional information about the rule
    destAddresses List<String>
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    destCountries List<String>
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    destIpCategories List<String>
    destIpGroups NatControlRulesDestIpGroups
    list of destination ip groups
    destIpv6Groups NatControlRulesDestIpv6Groups
    list of destination ipv6 groups
    deviceGroups NatControlRulesDeviceGroups
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices NatControlRulesDevices
    Name-ID pairs of devices for which rule must be applied.
    enableFullLogging Boolean
    groups NatControlRulesGroups
    list of groups for which rule must be applied
    labels NatControlRulesLabels
    list of Labels that are applicable to the rule.
    locationGroups NatControlRulesLocationGroups
    list of locations groups
    locations NatControlRulesLocations
    list of locations for which rule must be applied
    name String
    Name of the nat control policy rule
    nwServiceGroups NatControlRulesNwServiceGroups
    list of nw service groups
    nwServices NatControlRulesNwServices
    list of nw services
    order Integer
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined Boolean
    If set to true, a predefined rule is applied
    rank Integer
    Admin rank of the nat control policy rule
    redirectFqdn String
    The action the nat control policy rule takes when packets match the rule
    redirectIp String
    The action the nat control policy rule takes when packets match the rule
    redirectPort Integer
    The action the nat control policy rule takes when packets match the rule
    resCategories List<String>
    List of destination domain categories to which the rule applies
    srcIpGroups NatControlRulesSrcIpGroups
    list of source ip groups
    srcIps List<String>
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    srcIpv6Groups NatControlRulesSrcIpv6Groups
    list of source ipv6 groups
    state String
    Determines whether the nat control policy rule is enabled or disabled
    timeWindows NatControlRulesTimeWindows
    The time interval in which the nat control policy rule applies
    users NatControlRulesUsers
    list of users for which rule must be applied
    defaultRule boolean
    If set to true, the default rule is applied
    departments NatControlRulesDepartments
    list of departments for which rule must be applied
    description string
    Additional information about the rule
    destAddresses string[]
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    destCountries string[]
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    destIpCategories string[]
    destIpGroups NatControlRulesDestIpGroups
    list of destination ip groups
    destIpv6Groups NatControlRulesDestIpv6Groups
    list of destination ipv6 groups
    deviceGroups NatControlRulesDeviceGroups
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices NatControlRulesDevices
    Name-ID pairs of devices for which rule must be applied.
    enableFullLogging boolean
    groups NatControlRulesGroups
    list of groups for which rule must be applied
    labels NatControlRulesLabels
    list of Labels that are applicable to the rule.
    locationGroups NatControlRulesLocationGroups
    list of locations groups
    locations NatControlRulesLocations
    list of locations for which rule must be applied
    name string
    Name of the nat control policy rule
    nwServiceGroups NatControlRulesNwServiceGroups
    list of nw service groups
    nwServices NatControlRulesNwServices
    list of nw services
    order number
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined boolean
    If set to true, a predefined rule is applied
    rank number
    Admin rank of the nat control policy rule
    redirectFqdn string
    The action the nat control policy rule takes when packets match the rule
    redirectIp string
    The action the nat control policy rule takes when packets match the rule
    redirectPort number
    The action the nat control policy rule takes when packets match the rule
    resCategories string[]
    List of destination domain categories to which the rule applies
    srcIpGroups NatControlRulesSrcIpGroups
    list of source ip groups
    srcIps string[]
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    srcIpv6Groups NatControlRulesSrcIpv6Groups
    list of source ipv6 groups
    state string
    Determines whether the nat control policy rule is enabled or disabled
    timeWindows NatControlRulesTimeWindows
    The time interval in which the nat control policy rule applies
    users NatControlRulesUsers
    list of users for which rule must be applied
    default_rule bool
    If set to true, the default rule is applied
    departments NatControlRulesDepartmentsArgs
    list of departments for which rule must be applied
    description str
    Additional information about the rule
    dest_addresses Sequence[str]
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    dest_countries Sequence[str]
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    dest_ip_categories Sequence[str]
    dest_ip_groups NatControlRulesDestIpGroupsArgs
    list of destination ip groups
    dest_ipv6_groups NatControlRulesDestIpv6GroupsArgs
    list of destination ipv6 groups
    device_groups NatControlRulesDeviceGroupsArgs
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices NatControlRulesDevicesArgs
    Name-ID pairs of devices for which rule must be applied.
    enable_full_logging bool
    groups NatControlRulesGroupsArgs
    list of groups for which rule must be applied
    labels NatControlRulesLabelsArgs
    list of Labels that are applicable to the rule.
    location_groups NatControlRulesLocationGroupsArgs
    list of locations groups
    locations NatControlRulesLocationsArgs
    list of locations for which rule must be applied
    name str
    Name of the nat control policy rule
    nw_service_groups NatControlRulesNwServiceGroupsArgs
    list of nw service groups
    nw_services NatControlRulesNwServicesArgs
    list of nw services
    order int
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined bool
    If set to true, a predefined rule is applied
    rank int
    Admin rank of the nat control policy rule
    redirect_fqdn str
    The action the nat control policy rule takes when packets match the rule
    redirect_ip str
    The action the nat control policy rule takes when packets match the rule
    redirect_port int
    The action the nat control policy rule takes when packets match the rule
    res_categories Sequence[str]
    List of destination domain categories to which the rule applies
    src_ip_groups NatControlRulesSrcIpGroupsArgs
    list of source ip groups
    src_ips Sequence[str]
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    src_ipv6_groups NatControlRulesSrcIpv6GroupsArgs
    list of source ipv6 groups
    state str
    Determines whether the nat control policy rule is enabled or disabled
    time_windows NatControlRulesTimeWindowsArgs
    The time interval in which the nat control policy rule applies
    users NatControlRulesUsersArgs
    list of users for which rule must be applied
    defaultRule Boolean
    If set to true, the default rule is applied
    departments Property Map
    list of departments for which rule must be applied
    description String
    Additional information about the rule
    destAddresses List<String>
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    destCountries List<String>
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    destIpCategories List<String>
    destIpGroups Property Map
    list of destination ip groups
    destIpv6Groups Property Map
    list of destination ipv6 groups
    deviceGroups Property Map
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices Property Map
    Name-ID pairs of devices for which rule must be applied.
    enableFullLogging Boolean
    groups Property Map
    list of groups for which rule must be applied
    labels Property Map
    list of Labels that are applicable to the rule.
    locationGroups Property Map
    list of locations groups
    locations Property Map
    list of locations for which rule must be applied
    name String
    Name of the nat control policy rule
    nwServiceGroups Property Map
    list of nw service groups
    nwServices Property Map
    list of nw services
    order Number
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined Boolean
    If set to true, a predefined rule is applied
    rank Number
    Admin rank of the nat control policy rule
    redirectFqdn String
    The action the nat control policy rule takes when packets match the rule
    redirectIp String
    The action the nat control policy rule takes when packets match the rule
    redirectPort Number
    The action the nat control policy rule takes when packets match the rule
    resCategories List<String>
    List of destination domain categories to which the rule applies
    srcIpGroups Property Map
    list of source ip groups
    srcIps List<String>
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    srcIpv6Groups Property Map
    list of source ipv6 groups
    state String
    Determines whether the nat control policy rule is enabled or disabled
    timeWindows Property Map
    The time interval in which the nat control policy rule applies
    users Property Map
    list of users for which rule must be applied

    Outputs

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

    Get an existing NatControlRules 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?: NatControlRulesState, opts?: CustomResourceOptions): NatControlRules
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_rule: Optional[bool] = None,
            departments: Optional[NatControlRulesDepartmentsArgs] = None,
            description: Optional[str] = None,
            dest_addresses: Optional[Sequence[str]] = None,
            dest_countries: Optional[Sequence[str]] = None,
            dest_ip_categories: Optional[Sequence[str]] = None,
            dest_ip_groups: Optional[NatControlRulesDestIpGroupsArgs] = None,
            dest_ipv6_groups: Optional[NatControlRulesDestIpv6GroupsArgs] = None,
            device_groups: Optional[NatControlRulesDeviceGroupsArgs] = None,
            devices: Optional[NatControlRulesDevicesArgs] = None,
            enable_full_logging: Optional[bool] = None,
            groups: Optional[NatControlRulesGroupsArgs] = None,
            labels: Optional[NatControlRulesLabelsArgs] = None,
            location_groups: Optional[NatControlRulesLocationGroupsArgs] = None,
            locations: Optional[NatControlRulesLocationsArgs] = None,
            name: Optional[str] = None,
            nw_service_groups: Optional[NatControlRulesNwServiceGroupsArgs] = None,
            nw_services: Optional[NatControlRulesNwServicesArgs] = None,
            order: Optional[int] = None,
            predefined: Optional[bool] = None,
            rank: Optional[int] = None,
            redirect_fqdn: Optional[str] = None,
            redirect_ip: Optional[str] = None,
            redirect_port: Optional[int] = None,
            res_categories: Optional[Sequence[str]] = None,
            rule_id: Optional[int] = None,
            src_ip_groups: Optional[NatControlRulesSrcIpGroupsArgs] = None,
            src_ips: Optional[Sequence[str]] = None,
            src_ipv6_groups: Optional[NatControlRulesSrcIpv6GroupsArgs] = None,
            state: Optional[str] = None,
            time_windows: Optional[NatControlRulesTimeWindowsArgs] = None,
            users: Optional[NatControlRulesUsersArgs] = None) -> NatControlRules
    func GetNatControlRules(ctx *Context, name string, id IDInput, state *NatControlRulesState, opts ...ResourceOption) (*NatControlRules, error)
    public static NatControlRules Get(string name, Input<string> id, NatControlRulesState? state, CustomResourceOptions? opts = null)
    public static NatControlRules get(String name, Output<String> id, NatControlRulesState state, CustomResourceOptions options)
    resources:  _:    type: zia:NatControlRules    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:
    DefaultRule bool
    If set to true, the default rule is applied
    Departments zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDepartments
    list of departments for which rule must be applied
    Description string
    Additional information about the rule
    DestAddresses List<string>
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    DestCountries List<string>
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    DestIpCategories List<string>
    DestIpGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDestIpGroups
    list of destination ip groups
    DestIpv6Groups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDestIpv6Groups
    list of destination ipv6 groups
    DeviceGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDeviceGroups
    This field is applicable for devices that are managed using Zscaler Client Connector.
    Devices zscaler.PulumiPackage.Zia.Inputs.NatControlRulesDevices
    Name-ID pairs of devices for which rule must be applied.
    EnableFullLogging bool
    Groups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesGroups
    list of groups for which rule must be applied
    Labels zscaler.PulumiPackage.Zia.Inputs.NatControlRulesLabels
    list of Labels that are applicable to the rule.
    LocationGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesLocationGroups
    list of locations groups
    Locations zscaler.PulumiPackage.Zia.Inputs.NatControlRulesLocations
    list of locations for which rule must be applied
    Name string
    Name of the nat control policy rule
    NwServiceGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesNwServiceGroups
    list of nw service groups
    NwServices zscaler.PulumiPackage.Zia.Inputs.NatControlRulesNwServices
    list of nw services
    Order int
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    Predefined bool
    If set to true, a predefined rule is applied
    Rank int
    Admin rank of the nat control policy rule
    RedirectFqdn string
    The action the nat control policy rule takes when packets match the rule
    RedirectIp string
    The action the nat control policy rule takes when packets match the rule
    RedirectPort int
    The action the nat control policy rule takes when packets match the rule
    ResCategories List<string>
    List of destination domain categories to which the rule applies
    RuleId int
    SrcIpGroups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesSrcIpGroups
    list of source ip groups
    SrcIps List<string>
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    SrcIpv6Groups zscaler.PulumiPackage.Zia.Inputs.NatControlRulesSrcIpv6Groups
    list of source ipv6 groups
    State string
    Determines whether the nat control policy rule is enabled or disabled
    TimeWindows zscaler.PulumiPackage.Zia.Inputs.NatControlRulesTimeWindows
    The time interval in which the nat control policy rule applies
    Users zscaler.PulumiPackage.Zia.Inputs.NatControlRulesUsers
    list of users for which rule must be applied
    DefaultRule bool
    If set to true, the default rule is applied
    Departments NatControlRulesDepartmentsArgs
    list of departments for which rule must be applied
    Description string
    Additional information about the rule
    DestAddresses []string
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    DestCountries []string
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    DestIpCategories []string
    DestIpGroups NatControlRulesDestIpGroupsArgs
    list of destination ip groups
    DestIpv6Groups NatControlRulesDestIpv6GroupsArgs
    list of destination ipv6 groups
    DeviceGroups NatControlRulesDeviceGroupsArgs
    This field is applicable for devices that are managed using Zscaler Client Connector.
    Devices NatControlRulesDevicesArgs
    Name-ID pairs of devices for which rule must be applied.
    EnableFullLogging bool
    Groups NatControlRulesGroupsArgs
    list of groups for which rule must be applied
    Labels NatControlRulesLabelsArgs
    list of Labels that are applicable to the rule.
    LocationGroups NatControlRulesLocationGroupsArgs
    list of locations groups
    Locations NatControlRulesLocationsArgs
    list of locations for which rule must be applied
    Name string
    Name of the nat control policy rule
    NwServiceGroups NatControlRulesNwServiceGroupsArgs
    list of nw service groups
    NwServices NatControlRulesNwServicesArgs
    list of nw services
    Order int
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    Predefined bool
    If set to true, a predefined rule is applied
    Rank int
    Admin rank of the nat control policy rule
    RedirectFqdn string
    The action the nat control policy rule takes when packets match the rule
    RedirectIp string
    The action the nat control policy rule takes when packets match the rule
    RedirectPort int
    The action the nat control policy rule takes when packets match the rule
    ResCategories []string
    List of destination domain categories to which the rule applies
    RuleId int
    SrcIpGroups NatControlRulesSrcIpGroupsArgs
    list of source ip groups
    SrcIps []string
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    SrcIpv6Groups NatControlRulesSrcIpv6GroupsArgs
    list of source ipv6 groups
    State string
    Determines whether the nat control policy rule is enabled or disabled
    TimeWindows NatControlRulesTimeWindowsArgs
    The time interval in which the nat control policy rule applies
    Users NatControlRulesUsersArgs
    list of users for which rule must be applied
    defaultRule Boolean
    If set to true, the default rule is applied
    departments NatControlRulesDepartments
    list of departments for which rule must be applied
    description String
    Additional information about the rule
    destAddresses List<String>
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    destCountries List<String>
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    destIpCategories List<String>
    destIpGroups NatControlRulesDestIpGroups
    list of destination ip groups
    destIpv6Groups NatControlRulesDestIpv6Groups
    list of destination ipv6 groups
    deviceGroups NatControlRulesDeviceGroups
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices NatControlRulesDevices
    Name-ID pairs of devices for which rule must be applied.
    enableFullLogging Boolean
    groups NatControlRulesGroups
    list of groups for which rule must be applied
    labels NatControlRulesLabels
    list of Labels that are applicable to the rule.
    locationGroups NatControlRulesLocationGroups
    list of locations groups
    locations NatControlRulesLocations
    list of locations for which rule must be applied
    name String
    Name of the nat control policy rule
    nwServiceGroups NatControlRulesNwServiceGroups
    list of nw service groups
    nwServices NatControlRulesNwServices
    list of nw services
    order Integer
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined Boolean
    If set to true, a predefined rule is applied
    rank Integer
    Admin rank of the nat control policy rule
    redirectFqdn String
    The action the nat control policy rule takes when packets match the rule
    redirectIp String
    The action the nat control policy rule takes when packets match the rule
    redirectPort Integer
    The action the nat control policy rule takes when packets match the rule
    resCategories List<String>
    List of destination domain categories to which the rule applies
    ruleId Integer
    srcIpGroups NatControlRulesSrcIpGroups
    list of source ip groups
    srcIps List<String>
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    srcIpv6Groups NatControlRulesSrcIpv6Groups
    list of source ipv6 groups
    state String
    Determines whether the nat control policy rule is enabled or disabled
    timeWindows NatControlRulesTimeWindows
    The time interval in which the nat control policy rule applies
    users NatControlRulesUsers
    list of users for which rule must be applied
    defaultRule boolean
    If set to true, the default rule is applied
    departments NatControlRulesDepartments
    list of departments for which rule must be applied
    description string
    Additional information about the rule
    destAddresses string[]
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    destCountries string[]
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    destIpCategories string[]
    destIpGroups NatControlRulesDestIpGroups
    list of destination ip groups
    destIpv6Groups NatControlRulesDestIpv6Groups
    list of destination ipv6 groups
    deviceGroups NatControlRulesDeviceGroups
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices NatControlRulesDevices
    Name-ID pairs of devices for which rule must be applied.
    enableFullLogging boolean
    groups NatControlRulesGroups
    list of groups for which rule must be applied
    labels NatControlRulesLabels
    list of Labels that are applicable to the rule.
    locationGroups NatControlRulesLocationGroups
    list of locations groups
    locations NatControlRulesLocations
    list of locations for which rule must be applied
    name string
    Name of the nat control policy rule
    nwServiceGroups NatControlRulesNwServiceGroups
    list of nw service groups
    nwServices NatControlRulesNwServices
    list of nw services
    order number
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined boolean
    If set to true, a predefined rule is applied
    rank number
    Admin rank of the nat control policy rule
    redirectFqdn string
    The action the nat control policy rule takes when packets match the rule
    redirectIp string
    The action the nat control policy rule takes when packets match the rule
    redirectPort number
    The action the nat control policy rule takes when packets match the rule
    resCategories string[]
    List of destination domain categories to which the rule applies
    ruleId number
    srcIpGroups NatControlRulesSrcIpGroups
    list of source ip groups
    srcIps string[]
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    srcIpv6Groups NatControlRulesSrcIpv6Groups
    list of source ipv6 groups
    state string
    Determines whether the nat control policy rule is enabled or disabled
    timeWindows NatControlRulesTimeWindows
    The time interval in which the nat control policy rule applies
    users NatControlRulesUsers
    list of users for which rule must be applied
    default_rule bool
    If set to true, the default rule is applied
    departments NatControlRulesDepartmentsArgs
    list of departments for which rule must be applied
    description str
    Additional information about the rule
    dest_addresses Sequence[str]
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    dest_countries Sequence[str]
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    dest_ip_categories Sequence[str]
    dest_ip_groups NatControlRulesDestIpGroupsArgs
    list of destination ip groups
    dest_ipv6_groups NatControlRulesDestIpv6GroupsArgs
    list of destination ipv6 groups
    device_groups NatControlRulesDeviceGroupsArgs
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices NatControlRulesDevicesArgs
    Name-ID pairs of devices for which rule must be applied.
    enable_full_logging bool
    groups NatControlRulesGroupsArgs
    list of groups for which rule must be applied
    labels NatControlRulesLabelsArgs
    list of Labels that are applicable to the rule.
    location_groups NatControlRulesLocationGroupsArgs
    list of locations groups
    locations NatControlRulesLocationsArgs
    list of locations for which rule must be applied
    name str
    Name of the nat control policy rule
    nw_service_groups NatControlRulesNwServiceGroupsArgs
    list of nw service groups
    nw_services NatControlRulesNwServicesArgs
    list of nw services
    order int
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined bool
    If set to true, a predefined rule is applied
    rank int
    Admin rank of the nat control policy rule
    redirect_fqdn str
    The action the nat control policy rule takes when packets match the rule
    redirect_ip str
    The action the nat control policy rule takes when packets match the rule
    redirect_port int
    The action the nat control policy rule takes when packets match the rule
    res_categories Sequence[str]
    List of destination domain categories to which the rule applies
    rule_id int
    src_ip_groups NatControlRulesSrcIpGroupsArgs
    list of source ip groups
    src_ips Sequence[str]
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    src_ipv6_groups NatControlRulesSrcIpv6GroupsArgs
    list of source ipv6 groups
    state str
    Determines whether the nat control policy rule is enabled or disabled
    time_windows NatControlRulesTimeWindowsArgs
    The time interval in which the nat control policy rule applies
    users NatControlRulesUsersArgs
    list of users for which rule must be applied
    defaultRule Boolean
    If set to true, the default rule is applied
    departments Property Map
    list of departments for which rule must be applied
    description String
    Additional information about the rule
    destAddresses List<String>
    Destination addresses. Supports IPv4, FQDNs, or wildcard FQDNs
    destCountries List<String>
    Destination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries.
    destIpCategories List<String>
    destIpGroups Property Map
    list of destination ip groups
    destIpv6Groups Property Map
    list of destination ipv6 groups
    deviceGroups Property Map
    This field is applicable for devices that are managed using Zscaler Client Connector.
    devices Property Map
    Name-ID pairs of devices for which rule must be applied.
    enableFullLogging Boolean
    groups Property Map
    list of groups for which rule must be applied
    labels Property Map
    list of Labels that are applicable to the rule.
    locationGroups Property Map
    list of locations groups
    locations Property Map
    list of locations for which rule must be applied
    name String
    Name of the nat control policy rule
    nwServiceGroups Property Map
    list of nw service groups
    nwServices Property Map
    list of nw services
    order Number
    Rule order number. If omitted, the rule will be added to the end of the rule set.
    predefined Boolean
    If set to true, a predefined rule is applied
    rank Number
    Admin rank of the nat control policy rule
    redirectFqdn String
    The action the nat control policy rule takes when packets match the rule
    redirectIp String
    The action the nat control policy rule takes when packets match the rule
    redirectPort Number
    The action the nat control policy rule takes when packets match the rule
    resCategories List<String>
    List of destination domain categories to which the rule applies
    ruleId Number
    srcIpGroups Property Map
    list of source ip groups
    srcIps List<String>
    User-defined source IP addresses for which the rule is applicable. If not set, the rule is not restricted to a specific source IP address.
    srcIpv6Groups Property Map
    list of source ipv6 groups
    state String
    Determines whether the nat control policy rule is enabled or disabled
    timeWindows Property Map
    The time interval in which the nat control policy rule applies
    users Property Map
    list of users for which rule must be applied

    Supporting Types

    NatControlRulesDepartments, NatControlRulesDepartmentsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesDestIpGroups, NatControlRulesDestIpGroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesDestIpv6Groups, NatControlRulesDestIpv6GroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesDeviceGroups, NatControlRulesDeviceGroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesDevices, NatControlRulesDevicesArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesGroups, NatControlRulesGroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesLabels, NatControlRulesLabelsArgs

    Id int
    Id int
    id Integer
    id number
    id int
    id Number

    NatControlRulesLocationGroups, NatControlRulesLocationGroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesLocations, NatControlRulesLocationsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesNwServiceGroups, NatControlRulesNwServiceGroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesNwServices, NatControlRulesNwServicesArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesSrcIpGroups, NatControlRulesSrcIpGroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesSrcIpv6Groups, NatControlRulesSrcIpv6GroupsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesTimeWindows, NatControlRulesTimeWindowsArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    NatControlRulesUsers, NatControlRulesUsersArgs

    Ids List<int>
    Ids []int
    ids List<Integer>
    ids number[]
    ids Sequence[int]
    ids List<Number>

    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_nat_control_rules can be imported by using <RULE ID> or <RULE NAME> as the import ID.

    For example:

    $ pulumi import zia:index/natControlRules:NatControlRules example <rule_id>
    

    or

    $ pulumi import zia:index/natControlRules:NatControlRules 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.1.1 published on Tuesday, Jun 24, 2025 by Zscaler