zia.getForwardingControlRule
Explore with Pulumi AI
Use the forwarding_control_rule data source to get information about a forwarding control rule which is used to forward selective Zscaler traffic to specific destinations based on your needs.For example, if you want to forward specific web traffic to a third-party proxy service or if you want to forward source IP anchored application traffic to a specific Zscaler Private Access (ZPA) App Connector or internal application traffic through ZIA threat and data protection engines, use forwarding control by configuring appropriate rules.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as zia from "@pulumi/zia";
const this = zia.getForwardingControlRule({
name: "FWD_RULE01",
});
import pulumi
import pulumi_zia as zia
this = zia.get_forwarding_control_rule(name="FWD_RULE01")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/zscaler/pulumi-zia/sdk/go/zia"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := zia.LookupForwardingControlRule(ctx, &zia.LookupForwardingControlRuleArgs{
Name: pulumi.StringRef("FWD_RULE01"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = Pulumi.Zia;
return await Deployment.RunAsync(() =>
{
var @this = Zia.GetForwardingControlRule.Invoke(new()
{
Name = "FWD_RULE01",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetForwardingControlRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var this = ZiaFunctions.getForwardingControlRule(GetForwardingControlRuleArgs.builder()
.name("FWD_RULE01")
.build());
}
}
variables:
this:
fn::invoke:
Function: zia:getForwardingControlRule
Arguments:
name: FWD_RULE01
Using getForwardingControlRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getForwardingControlRule(args: GetForwardingControlRuleArgs, opts?: InvokeOptions): Promise<GetForwardingControlRuleResult>
function getForwardingControlRuleOutput(args: GetForwardingControlRuleOutputArgs, opts?: InvokeOptions): Output<GetForwardingControlRuleResult>
def get_forwarding_control_rule(id: Optional[int] = None,
name: Optional[str] = None,
type: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetForwardingControlRuleResult
def get_forwarding_control_rule_output(id: Optional[pulumi.Input[int]] = None,
name: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetForwardingControlRuleResult]
func LookupForwardingControlRule(ctx *Context, args *LookupForwardingControlRuleArgs, opts ...InvokeOption) (*LookupForwardingControlRuleResult, error)
func LookupForwardingControlRuleOutput(ctx *Context, args *LookupForwardingControlRuleOutputArgs, opts ...InvokeOption) LookupForwardingControlRuleResultOutput
> Note: This function is named LookupForwardingControlRule
in the Go SDK.
public static class GetForwardingControlRule
{
public static Task<GetForwardingControlRuleResult> InvokeAsync(GetForwardingControlRuleArgs args, InvokeOptions? opts = null)
public static Output<GetForwardingControlRuleResult> Invoke(GetForwardingControlRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetForwardingControlRuleResult> getForwardingControlRule(GetForwardingControlRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: zia:index/getForwardingControlRule:getForwardingControlRule
arguments:
# arguments dictionary
The following arguments are supported:
getForwardingControlRule Result
The following output properties are available:
- Departments
List<zscaler.
Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Department> - (list) Apply to any number of departments When not used it implies
Any
to apply the rule to all departments. - Description string
- (string) - Additional information about the forwarding rule
- Dest
Addresses List<string> - ** - (list) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
- Dest
Countries List<string> - ** - (list) estination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries. Provide a 2 letter ISO3166 Alpha2 Country code.
- Dest
Ip List<string>Categories - ** - (list) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
- Dest
Ip List<zscaler.Groups Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Dest Ip Group> - ** - (list) Any number of destination IP address groups that you want to control with this rule.
- Dest
Ipv6Groups List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Dest Ipv6Group> - Device
Groups List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Device Group> - (list) Name-ID pairs of device groups for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- Devices
List<zscaler.
Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Device> - (list) Name-ID pairs of devices for which the rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- Ec
Groups List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Ec Group> - (list) - Name-ID pairs of the Zscaler Cloud Connector groups to which the forwarding rule applies
- Forward
Method string - (string) - The type of traffic forwarding method selected from the available options.
- Groups
List<zscaler.
Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Group> - (list) You can manually select up to
8
groups. When not used it impliesAny
to apply the rule to all groups. - Labels
List<zscaler.
Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Label> - (list) Labels that are applicable to the rule.
- Location
Groups List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Location Group> - (Optional) You can manually select up to
32
location groups. When not used it impliesAny
to apply the rule to all location groups. - Locations
List<zscaler.
Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Location> - (Optional) You can manually select up to
8
locations. When not used it impliesAny
to apply the rule to all groups. - Nw
Application List<zscaler.Groups Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Nw Application Group> - (list) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
- Nw
Applications List<string> - (Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
- Nw
Service List<zscaler.Groups Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Nw Service Group> - (list) Any number of predefined or custom network service groups to which the rule applies.
- Nw
Services List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Nw Service> - (list) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to
1,024
additional custom services. - Order int
- (string) - The order of execution for the forwarding rule order.
- Proxy
Gateways List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Proxy Gateway> - (set) The proxy gateway for which the rule is applicable. This field is applicable only for the
PROXYCHAIN
forwarding method. - Rank int
- Res
Categories List<string> - ** - (list) List of destination domain categories to which the rule applies.
- Src
Ip List<zscaler.Groups Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Src Ip Group> - (list) Any number of source IP address groups that you want to control with this rule.
- Src
Ips List<string> - (Optional) You can enter individual IP addresses, subnets, or address ranges.
- Src
Ipv6Groups List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Src Ipv6Group> - State string
- (string) - Indicates whether the forwarding rule is enabled or disabled.
- Users
List<zscaler.
Pulumi Package. Zia. Outputs. Get Forwarding Control Rule User> - (list) You can manually select up to
4
general and/or special users. When not used it impliesAny
to apply the rule to all users. - Zpa
App List<zscaler.Segments Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Zpa App Segment> - (set) The list of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ZPA
Gateway forwarding method. - Zpa
Application List<zscaler.Segment Groups Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Zpa Application Segment Group> - (set) List of ZPA Application Segment Groups for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - Zpa
Application List<zscaler.Segments Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Zpa Application Segment> - (set) List of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - Zpa
Broker boolRule - Zpa
Gateways List<zscaler.Pulumi Package. Zia. Outputs. Get Forwarding Control Rule Zpa Gateway> - (set) The ZPA Gateway for which this rule is applicable. This field is applicable only for the
ZPA
forwarding method. - Id int
- (int) Identifier that uniquely identifies an entity
- Name string
- (string) The configured name of the entity
- Type string
- (string) - The rule type selected from the available options
- Departments
[]Get
Forwarding Control Rule Department - (list) Apply to any number of departments When not used it implies
Any
to apply the rule to all departments. - Description string
- (string) - Additional information about the forwarding rule
- Dest
Addresses []string - ** - (list) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
- Dest
Countries []string - ** - (list) estination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries. Provide a 2 letter ISO3166 Alpha2 Country code.
- Dest
Ip []stringCategories - ** - (list) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
- Dest
Ip []GetGroups Forwarding Control Rule Dest Ip Group - ** - (list) Any number of destination IP address groups that you want to control with this rule.
- Dest
Ipv6Groups []GetForwarding Control Rule Dest Ipv6Group - Device
Groups []GetForwarding Control Rule Device Group - (list) Name-ID pairs of device groups for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- Devices
[]Get
Forwarding Control Rule Device - (list) Name-ID pairs of devices for which the rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- Ec
Groups []GetForwarding Control Rule Ec Group - (list) - Name-ID pairs of the Zscaler Cloud Connector groups to which the forwarding rule applies
- Forward
Method string - (string) - The type of traffic forwarding method selected from the available options.
- Groups
[]Get
Forwarding Control Rule Group - (list) You can manually select up to
8
groups. When not used it impliesAny
to apply the rule to all groups. - Labels
[]Get
Forwarding Control Rule Label - (list) Labels that are applicable to the rule.
- Location
Groups []GetForwarding Control Rule Location Group - (Optional) You can manually select up to
32
location groups. When not used it impliesAny
to apply the rule to all location groups. - Locations
[]Get
Forwarding Control Rule Location - (Optional) You can manually select up to
8
locations. When not used it impliesAny
to apply the rule to all groups. - Nw
Application []GetGroups Forwarding Control Rule Nw Application Group - (list) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
- Nw
Applications []string - (Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
- Nw
Service []GetGroups Forwarding Control Rule Nw Service Group - (list) Any number of predefined or custom network service groups to which the rule applies.
- Nw
Services []GetForwarding Control Rule Nw Service - (list) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to
1,024
additional custom services. - Order int
- (string) - The order of execution for the forwarding rule order.
- Proxy
Gateways []GetForwarding Control Rule Proxy Gateway - (set) The proxy gateway for which the rule is applicable. This field is applicable only for the
PROXYCHAIN
forwarding method. - Rank int
- Res
Categories []string - ** - (list) List of destination domain categories to which the rule applies.
- Src
Ip []GetGroups Forwarding Control Rule Src Ip Group - (list) Any number of source IP address groups that you want to control with this rule.
- Src
Ips []string - (Optional) You can enter individual IP addresses, subnets, or address ranges.
- Src
Ipv6Groups []GetForwarding Control Rule Src Ipv6Group - State string
- (string) - Indicates whether the forwarding rule is enabled or disabled.
- Users
[]Get
Forwarding Control Rule User - (list) You can manually select up to
4
general and/or special users. When not used it impliesAny
to apply the rule to all users. - Zpa
App []GetSegments Forwarding Control Rule Zpa App Segment - (set) The list of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ZPA
Gateway forwarding method. - Zpa
Application []GetSegment Groups Forwarding Control Rule Zpa Application Segment Group - (set) List of ZPA Application Segment Groups for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - Zpa
Application []GetSegments Forwarding Control Rule Zpa Application Segment - (set) List of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - Zpa
Broker boolRule - Zpa
Gateways []GetForwarding Control Rule Zpa Gateway - (set) The ZPA Gateway for which this rule is applicable. This field is applicable only for the
ZPA
forwarding method. - Id int
- (int) Identifier that uniquely identifies an entity
- Name string
- (string) The configured name of the entity
- Type string
- (string) - The rule type selected from the available options
- departments
List<Get
Forwarding Control Rule Department> - (list) Apply to any number of departments When not used it implies
Any
to apply the rule to all departments. - description String
- (string) - Additional information about the forwarding rule
- dest
Addresses List<String> - ** - (list) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
- dest
Countries List<String> - ** - (list) estination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries. Provide a 2 letter ISO3166 Alpha2 Country code.
- dest
Ip List<String>Categories - ** - (list) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
- dest
Ip List<GetGroups Forwarding Control Rule Dest Ip Group> - ** - (list) Any number of destination IP address groups that you want to control with this rule.
- dest
Ipv6Groups List<GetForwarding Control Rule Dest Ipv6Group> - device
Groups List<GetForwarding Control Rule Device Group> - (list) Name-ID pairs of device groups for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- devices
List<Get
Forwarding Control Rule Device> - (list) Name-ID pairs of devices for which the rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- ec
Groups List<GetForwarding Control Rule Ec Group> - (list) - Name-ID pairs of the Zscaler Cloud Connector groups to which the forwarding rule applies
- forward
Method String - (string) - The type of traffic forwarding method selected from the available options.
- groups
List<Get
Forwarding Control Rule Group> - (list) You can manually select up to
8
groups. When not used it impliesAny
to apply the rule to all groups. - labels
List<Get
Forwarding Control Rule Label> - (list) Labels that are applicable to the rule.
- location
Groups List<GetForwarding Control Rule Location Group> - (Optional) You can manually select up to
32
location groups. When not used it impliesAny
to apply the rule to all location groups. - locations
List<Get
Forwarding Control Rule Location> - (Optional) You can manually select up to
8
locations. When not used it impliesAny
to apply the rule to all groups. - nw
Application List<GetGroups Forwarding Control Rule Nw Application Group> - (list) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
- nw
Applications List<String> - (Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
- nw
Service List<GetGroups Forwarding Control Rule Nw Service Group> - (list) Any number of predefined or custom network service groups to which the rule applies.
- nw
Services List<GetForwarding Control Rule Nw Service> - (list) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to
1,024
additional custom services. - order Integer
- (string) - The order of execution for the forwarding rule order.
- proxy
Gateways List<GetForwarding Control Rule Proxy Gateway> - (set) The proxy gateway for which the rule is applicable. This field is applicable only for the
PROXYCHAIN
forwarding method. - rank Integer
- res
Categories List<String> - ** - (list) List of destination domain categories to which the rule applies.
- src
Ip List<GetGroups Forwarding Control Rule Src Ip Group> - (list) Any number of source IP address groups that you want to control with this rule.
- src
Ips List<String> - (Optional) You can enter individual IP addresses, subnets, or address ranges.
- src
Ipv6Groups List<GetForwarding Control Rule Src Ipv6Group> - state String
- (string) - Indicates whether the forwarding rule is enabled or disabled.
- users
List<Get
Forwarding Control Rule User> - (list) You can manually select up to
4
general and/or special users. When not used it impliesAny
to apply the rule to all users. - zpa
App List<GetSegments Forwarding Control Rule Zpa App Segment> - (set) The list of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ZPA
Gateway forwarding method. - zpa
Application List<GetSegment Groups Forwarding Control Rule Zpa Application Segment Group> - (set) List of ZPA Application Segment Groups for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa
Application List<GetSegments Forwarding Control Rule Zpa Application Segment> - (set) List of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa
Broker BooleanRule - zpa
Gateways List<GetForwarding Control Rule Zpa Gateway> - (set) The ZPA Gateway for which this rule is applicable. This field is applicable only for the
ZPA
forwarding method. - id Integer
- (int) Identifier that uniquely identifies an entity
- name String
- (string) The configured name of the entity
- type String
- (string) - The rule type selected from the available options
- departments
Get
Forwarding Control Rule Department[] - (list) Apply to any number of departments When not used it implies
Any
to apply the rule to all departments. - description string
- (string) - Additional information about the forwarding rule
- dest
Addresses string[] - ** - (list) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
- dest
Countries string[] - ** - (list) estination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries. Provide a 2 letter ISO3166 Alpha2 Country code.
- dest
Ip string[]Categories - ** - (list) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
- dest
Ip GetGroups Forwarding Control Rule Dest Ip Group[] - ** - (list) Any number of destination IP address groups that you want to control with this rule.
- dest
Ipv6Groups GetForwarding Control Rule Dest Ipv6Group[] - device
Groups GetForwarding Control Rule Device Group[] - (list) Name-ID pairs of device groups for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- devices
Get
Forwarding Control Rule Device[] - (list) Name-ID pairs of devices for which the rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- ec
Groups GetForwarding Control Rule Ec Group[] - (list) - Name-ID pairs of the Zscaler Cloud Connector groups to which the forwarding rule applies
- forward
Method string - (string) - The type of traffic forwarding method selected from the available options.
- groups
Get
Forwarding Control Rule Group[] - (list) You can manually select up to
8
groups. When not used it impliesAny
to apply the rule to all groups. - labels
Get
Forwarding Control Rule Label[] - (list) Labels that are applicable to the rule.
- location
Groups GetForwarding Control Rule Location Group[] - (Optional) You can manually select up to
32
location groups. When not used it impliesAny
to apply the rule to all location groups. - locations
Get
Forwarding Control Rule Location[] - (Optional) You can manually select up to
8
locations. When not used it impliesAny
to apply the rule to all groups. - nw
Application GetGroups Forwarding Control Rule Nw Application Group[] - (list) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
- nw
Applications string[] - (Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
- nw
Service GetGroups Forwarding Control Rule Nw Service Group[] - (list) Any number of predefined or custom network service groups to which the rule applies.
- nw
Services GetForwarding Control Rule Nw Service[] - (list) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to
1,024
additional custom services. - order number
- (string) - The order of execution for the forwarding rule order.
- proxy
Gateways GetForwarding Control Rule Proxy Gateway[] - (set) The proxy gateway for which the rule is applicable. This field is applicable only for the
PROXYCHAIN
forwarding method. - rank number
- res
Categories string[] - ** - (list) List of destination domain categories to which the rule applies.
- src
Ip GetGroups Forwarding Control Rule Src Ip Group[] - (list) Any number of source IP address groups that you want to control with this rule.
- src
Ips string[] - (Optional) You can enter individual IP addresses, subnets, or address ranges.
- src
Ipv6Groups GetForwarding Control Rule Src Ipv6Group[] - state string
- (string) - Indicates whether the forwarding rule is enabled or disabled.
- users
Get
Forwarding Control Rule User[] - (list) You can manually select up to
4
general and/or special users. When not used it impliesAny
to apply the rule to all users. - zpa
App GetSegments Forwarding Control Rule Zpa App Segment[] - (set) The list of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ZPA
Gateway forwarding method. - zpa
Application GetSegment Groups Forwarding Control Rule Zpa Application Segment Group[] - (set) List of ZPA Application Segment Groups for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa
Application GetSegments Forwarding Control Rule Zpa Application Segment[] - (set) List of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa
Broker booleanRule - zpa
Gateways GetForwarding Control Rule Zpa Gateway[] - (set) The ZPA Gateway for which this rule is applicable. This field is applicable only for the
ZPA
forwarding method. - id number
- (int) Identifier that uniquely identifies an entity
- name string
- (string) The configured name of the entity
- type string
- (string) - The rule type selected from the available options
- departments
Sequence[Get
Forwarding Control Rule Department] - (list) Apply to any number of departments When not used it implies
Any
to apply the rule to all departments. - description str
- (string) - Additional information about the forwarding rule
- dest_
addresses Sequence[str] - ** - (list) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
- dest_
countries Sequence[str] - ** - (list) estination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries. Provide a 2 letter ISO3166 Alpha2 Country code.
- dest_
ip_ Sequence[str]categories - ** - (list) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
- dest_
ip_ Sequence[Getgroups Forwarding Control Rule Dest Ip Group] - ** - (list) Any number of destination IP address groups that you want to control with this rule.
- dest_
ipv6_ Sequence[Getgroups Forwarding Control Rule Dest Ipv6Group] - device_
groups Sequence[GetForwarding Control Rule Device Group] - (list) Name-ID pairs of device groups for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- devices
Sequence[Get
Forwarding Control Rule Device] - (list) Name-ID pairs of devices for which the rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- ec_
groups Sequence[GetForwarding Control Rule Ec Group] - (list) - Name-ID pairs of the Zscaler Cloud Connector groups to which the forwarding rule applies
- forward_
method str - (string) - The type of traffic forwarding method selected from the available options.
- groups
Sequence[Get
Forwarding Control Rule Group] - (list) You can manually select up to
8
groups. When not used it impliesAny
to apply the rule to all groups. - labels
Sequence[Get
Forwarding Control Rule Label] - (list) Labels that are applicable to the rule.
- location_
groups Sequence[GetForwarding Control Rule Location Group] - (Optional) You can manually select up to
32
location groups. When not used it impliesAny
to apply the rule to all location groups. - locations
Sequence[Get
Forwarding Control Rule Location] - (Optional) You can manually select up to
8
locations. When not used it impliesAny
to apply the rule to all groups. - nw_
application_ Sequence[Getgroups Forwarding Control Rule Nw Application Group] - (list) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
- nw_
applications Sequence[str] - (Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
- nw_
service_ Sequence[Getgroups Forwarding Control Rule Nw Service Group] - (list) Any number of predefined or custom network service groups to which the rule applies.
- nw_
services Sequence[GetForwarding Control Rule Nw Service] - (list) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to
1,024
additional custom services. - order int
- (string) - The order of execution for the forwarding rule order.
- proxy_
gateways Sequence[GetForwarding Control Rule Proxy Gateway] - (set) The proxy gateway for which the rule is applicable. This field is applicable only for the
PROXYCHAIN
forwarding method. - rank int
- res_
categories Sequence[str] - ** - (list) List of destination domain categories to which the rule applies.
- src_
ip_ Sequence[Getgroups Forwarding Control Rule Src Ip Group] - (list) Any number of source IP address groups that you want to control with this rule.
- src_
ips Sequence[str] - (Optional) You can enter individual IP addresses, subnets, or address ranges.
- src_
ipv6_ Sequence[Getgroups Forwarding Control Rule Src Ipv6Group] - state str
- (string) - Indicates whether the forwarding rule is enabled or disabled.
- users
Sequence[Get
Forwarding Control Rule User] - (list) You can manually select up to
4
general and/or special users. When not used it impliesAny
to apply the rule to all users. - zpa_
app_ Sequence[Getsegments Forwarding Control Rule Zpa App Segment] - (set) The list of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ZPA
Gateway forwarding method. - zpa_
application_ Sequence[Getsegment_ groups Forwarding Control Rule Zpa Application Segment Group] - (set) List of ZPA Application Segment Groups for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa_
application_ Sequence[Getsegments Forwarding Control Rule Zpa Application Segment] - (set) List of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa_
broker_ boolrule - zpa_
gateways Sequence[GetForwarding Control Rule Zpa Gateway] - (set) The ZPA Gateway for which this rule is applicable. This field is applicable only for the
ZPA
forwarding method. - id int
- (int) Identifier that uniquely identifies an entity
- name str
- (string) The configured name of the entity
- type str
- (string) - The rule type selected from the available options
- departments List<Property Map>
- (list) Apply to any number of departments When not used it implies
Any
to apply the rule to all departments. - description String
- (string) - Additional information about the forwarding rule
- dest
Addresses List<String> - ** - (list) - IP addresses and fully qualified domain names (FQDNs), if the domain has multiple destination IP addresses or if its IP addresses may change. For IP addresses, you can enter individual IP addresses, subnets, or address ranges. If adding multiple items, hit Enter after each entry.
- dest
Countries List<String> - ** - (list) estination countries for which the rule is applicable. If not set, the rule is not restricted to specific destination countries. Provide a 2 letter ISO3166 Alpha2 Country code.
- dest
Ip List<String>Categories - ** - (list) identify destinations based on the URL category of the domain, select Any to apply the rule to all categories or select the specific categories you want to control.
- dest
Ip List<Property Map>Groups - ** - (list) Any number of destination IP address groups that you want to control with this rule.
- dest
Ipv6Groups List<Property Map> - device
Groups List<Property Map> - (list) Name-ID pairs of device groups for which the rule must be applied. This field is applicable for devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- devices List<Property Map>
- (list) Name-ID pairs of devices for which the rule must be applied. Specifies devices that are managed using Zscaler Client Connector. If no value is set, this field is ignored during the policy evaluation.
- ec
Groups List<Property Map> - (list) - Name-ID pairs of the Zscaler Cloud Connector groups to which the forwarding rule applies
- forward
Method String - (string) - The type of traffic forwarding method selected from the available options.
- groups List<Property Map>
- (list) You can manually select up to
8
groups. When not used it impliesAny
to apply the rule to all groups. - labels List<Property Map>
- (list) Labels that are applicable to the rule.
- location
Groups List<Property Map> - (Optional) You can manually select up to
32
location groups. When not used it impliesAny
to apply the rule to all location groups. - locations List<Property Map>
- (Optional) You can manually select up to
8
locations. When not used it impliesAny
to apply the rule to all groups. - nw
Application List<Property Map>Groups - (list) Any number of application groups that you want to control with this rule. The service provides predefined applications that you can group, but not modify
- nw
Applications List<String> - (Optional) When not used it applies the rule to all applications. The service provides predefined applications, which you can group, but not modify.
- nw
Service List<Property Map>Groups - (list) Any number of predefined or custom network service groups to which the rule applies.
- nw
Services List<Property Map> - (list) When not used it applies the rule to all network services or you can select specific network services. The Zscaler firewall has predefined services and you can configure up to
1,024
additional custom services. - order Number
- (string) - The order of execution for the forwarding rule order.
- proxy
Gateways List<Property Map> - (set) The proxy gateway for which the rule is applicable. This field is applicable only for the
PROXYCHAIN
forwarding method. - rank Number
- res
Categories List<String> - ** - (list) List of destination domain categories to which the rule applies.
- src
Ip List<Property Map>Groups - (list) Any number of source IP address groups that you want to control with this rule.
- src
Ips List<String> - (Optional) You can enter individual IP addresses, subnets, or address ranges.
- src
Ipv6Groups List<Property Map> - state String
- (string) - Indicates whether the forwarding rule is enabled or disabled.
- users List<Property Map>
- (list) You can manually select up to
4
general and/or special users. When not used it impliesAny
to apply the rule to all users. - zpa
App List<Property Map>Segments - (set) The list of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ZPA
Gateway forwarding method. - zpa
Application List<Property Map>Segment Groups - (set) List of ZPA Application Segment Groups for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa
Application List<Property Map>Segments - (set) List of ZPA Application Segments for which this rule is applicable. This field is applicable only for the
ECZPA
forwarding method (used for Zscaler Cloud Connector). - zpa
Broker BooleanRule - zpa
Gateways List<Property Map> - (set) The ZPA Gateway for which this rule is applicable. This field is applicable only for the
ZPA
forwarding method. - id Number
- (int) Identifier that uniquely identifies an entity
- name String
- (string) The configured name of the entity
- type String
- (string) - The rule type selected from the available options
Supporting Types
GetForwardingControlRuleDepartment
GetForwardingControlRuleDestIpGroup
GetForwardingControlRuleDestIpv6Group
GetForwardingControlRuleDevice
- Extensions Dictionary<string, string>
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Extensions map[string]string
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- extensions Map<String,String>
- id Integer
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- extensions {[key: string]: string}
- id number
- A unique identifier assigned to the forwarding rule.
- name string
- The name of the forwarding rule.
- extensions Mapping[str, str]
- id int
- A unique identifier assigned to the forwarding rule.
- name str
- The name of the forwarding rule.
- extensions Map<String>
- id Number
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
GetForwardingControlRuleDeviceGroup
- Extensions Dictionary<string, string>
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Extensions map[string]string
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- extensions Map<String,String>
- id Integer
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- extensions {[key: string]: string}
- id number
- A unique identifier assigned to the forwarding rule.
- name string
- The name of the forwarding rule.
- extensions Mapping[str, str]
- id int
- A unique identifier assigned to the forwarding rule.
- name str
- The name of the forwarding rule.
- extensions Map<String>
- id Number
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
GetForwardingControlRuleEcGroup
GetForwardingControlRuleGroup
GetForwardingControlRuleLabel
GetForwardingControlRuleLocation
GetForwardingControlRuleLocationGroup
GetForwardingControlRuleNwApplicationGroup
GetForwardingControlRuleNwService
GetForwardingControlRuleNwServiceGroup
GetForwardingControlRuleProxyGateway
GetForwardingControlRuleSrcIpGroup
GetForwardingControlRuleSrcIpv6Group
GetForwardingControlRuleUser
GetForwardingControlRuleZpaAppSegment
- External
Id string - (int) Identifier that uniquely identifies an entity
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- External
Id string - (int) Identifier that uniquely identifies an entity
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- external
Id String - (int) Identifier that uniquely identifies an entity
- id Integer
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- external
Id string - (int) Identifier that uniquely identifies an entity
- id number
- A unique identifier assigned to the forwarding rule.
- name string
- The name of the forwarding rule.
- external_
id str - (int) Identifier that uniquely identifies an entity
- id int
- A unique identifier assigned to the forwarding rule.
- name str
- The name of the forwarding rule.
- external
Id String - (int) Identifier that uniquely identifies an entity
- id Number
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
GetForwardingControlRuleZpaApplicationSegment
- Ddescription string
- Additional information about the Application Segment
- Deleted bool
- ID of the ZPA tenant where the Application Segment is configured
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Zpa
Id int - ID of the ZPA tenant where the Application Segment is configured
- Ddescription string
- Additional information about the Application Segment
- Deleted bool
- ID of the ZPA tenant where the Application Segment is configured
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Zpa
Id int - ID of the ZPA tenant where the Application Segment is configured
- ddescription String
- Additional information about the Application Segment
- deleted Boolean
- ID of the ZPA tenant where the Application Segment is configured
- id Integer
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- zpa
Id Integer - ID of the ZPA tenant where the Application Segment is configured
- ddescription string
- Additional information about the Application Segment
- deleted boolean
- ID of the ZPA tenant where the Application Segment is configured
- id number
- A unique identifier assigned to the forwarding rule.
- name string
- The name of the forwarding rule.
- zpa
Id number - ID of the ZPA tenant where the Application Segment is configured
- ddescription str
- Additional information about the Application Segment
- deleted bool
- ID of the ZPA tenant where the Application Segment is configured
- id int
- A unique identifier assigned to the forwarding rule.
- name str
- The name of the forwarding rule.
- zpa_
id int - ID of the ZPA tenant where the Application Segment is configured
- ddescription String
- Additional information about the Application Segment
- deleted Boolean
- ID of the ZPA tenant where the Application Segment is configured
- id Number
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- zpa
Id Number - ID of the ZPA tenant where the Application Segment is configured
GetForwardingControlRuleZpaApplicationSegmentGroup
- Deleted bool
- Indicates whether the ZPA Application Segment Group has been deleted
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Zpa
App intSegments Count - The number of ZPA Application Segments in the group
- Zpa
Id int - Indicates the external ID. Applicable only when this reference is of an external entity.
- Deleted bool
- Indicates whether the ZPA Application Segment Group has been deleted
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Zpa
App intSegments Count - The number of ZPA Application Segments in the group
- Zpa
Id int - Indicates the external ID. Applicable only when this reference is of an external entity.
- deleted Boolean
- Indicates whether the ZPA Application Segment Group has been deleted
- id Integer
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- zpa
App IntegerSegments Count - The number of ZPA Application Segments in the group
- zpa
Id Integer - Indicates the external ID. Applicable only when this reference is of an external entity.
- deleted boolean
- Indicates whether the ZPA Application Segment Group has been deleted
- id number
- A unique identifier assigned to the forwarding rule.
- name string
- The name of the forwarding rule.
- zpa
App numberSegments Count - The number of ZPA Application Segments in the group
- zpa
Id number - Indicates the external ID. Applicable only when this reference is of an external entity.
- deleted bool
- Indicates whether the ZPA Application Segment Group has been deleted
- id int
- A unique identifier assigned to the forwarding rule.
- name str
- The name of the forwarding rule.
- zpa_
app_ intsegments_ count - The number of ZPA Application Segments in the group
- zpa_
id int - Indicates the external ID. Applicable only when this reference is of an external entity.
- deleted Boolean
- Indicates whether the ZPA Application Segment Group has been deleted
- id Number
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- zpa
App NumberSegments Count - The number of ZPA Application Segments in the group
- zpa
Id Number - Indicates the external ID. Applicable only when this reference is of an external entity.
GetForwardingControlRuleZpaGateway
- Extensions Dictionary<string, string>
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- Extensions map[string]string
- Id int
- A unique identifier assigned to the forwarding rule.
- Name string
- The name of the forwarding rule.
- extensions Map<String,String>
- id Integer
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
- extensions {[key: string]: string}
- id number
- A unique identifier assigned to the forwarding rule.
- name string
- The name of the forwarding rule.
- extensions Mapping[str, str]
- id int
- A unique identifier assigned to the forwarding rule.
- name str
- The name of the forwarding rule.
- extensions Map<String>
- id Number
- A unique identifier assigned to the forwarding rule.
- name String
- The name of the forwarding rule.
Package Details
- Repository
- zia zscaler/pulumi-zia
- License
- MIT
- Notes
- This Pulumi package is based on the
zia
Terraform Provider.