Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getForwardingProxyGateway
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
zscaler/pulumi-zia

zia.getForwardingProxyGateway

Explore with Pulumi AI

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

    Use the zia_forwarding_control_proxy_gateway data source to retrieve the proxy gateway information. This data source can then be associated with the attribute proxy_gateway when creating a Forwarding Control Rule via the resource: zia.ForwardingControlRule

    Example Usage

    # ZIA Forwarding Control - Proxy Gateway
data "zia_forwarding_control_proxy_gateway" "this" {
  name = "Proxy_GW01"
}

    Using getForwardingProxyGateway

    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 getForwardingProxyGateway(args: GetForwardingProxyGatewayArgs, opts?: InvokeOptions): Promise<GetForwardingProxyGatewayResult>
function getForwardingProxyGatewayOutput(args: GetForwardingProxyGatewayOutputArgs, opts?: InvokeOptions): Output<GetForwardingProxyGatewayResult>
    def get_forwarding_proxy_gateway(id: Optional[int] = None,
                                 name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetForwardingProxyGatewayResult
def get_forwarding_proxy_gateway_output(id: Optional[pulumi.Input[int]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetForwardingProxyGatewayResult]
    func GetForwardingProxyGateway(ctx *Context, args *GetForwardingProxyGatewayArgs, opts ...InvokeOption) (*GetForwardingProxyGatewayResult, error)
func GetForwardingProxyGatewayOutput(ctx *Context, args *GetForwardingProxyGatewayOutputArgs, opts ...InvokeOption) GetForwardingProxyGatewayResultOutput

    > Note: This function is named GetForwardingProxyGateway in the Go SDK.

    public static class GetForwardingProxyGateway 
{
    public static Task<GetForwardingProxyGatewayResult> InvokeAsync(GetForwardingProxyGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetForwardingProxyGatewayResult> Invoke(GetForwardingProxyGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetForwardingProxyGatewayResult> getForwardingProxyGateway(GetForwardingProxyGatewayArgs args, InvokeOptions options)
public static Output<GetForwardingProxyGatewayResult> getForwardingProxyGateway(GetForwardingProxyGatewayArgs args, InvokeOptions options)

    fn::invoke:
  function: zia:index/getForwardingProxyGateway:getForwardingProxyGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    id Integer
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.
    id number
    The ID of the forwarding control Proxy Gateway resource.
    name string
    The name of the forwarding control Proxy Gateway to be exported.
    id int
    The ID of the forwarding control Proxy Gateway resource.
    name str
    The name of the forwarding control Proxy Gateway to be exported.
    id Number
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.

    getForwardingProxyGateway Result

    The following output properties are available:

    Description string
    (string) - Additional details about the Proxy gateway
    FailClosed bool
    (Boolean) - Indicates whether fail close is enabled to drop the traffic or disabled to allow the traffic when both primary and secondary proxies defined in this gateway are unreachable.
    Id int
    (string) A unique identifier for the secondary proxy gateway
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingProxyGatewayLastModifiedBy>
    (list) - Information about the admin user that last modified the Proxy gateway
    LastModifiedTime int
    (int) - Timestamp when the ZPA gateway was last modified
    Name string
    (string) The configured name for the secondary proxy gateway
    PrimaryProxies List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingProxyGatewayPrimaryProxy>
    (Set of String) - The primary proxy for the gateway. This field is not applicable to the Lite API.
    SecondaryProxies List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingProxyGatewaySecondaryProxy>
    () - The secondary proxy for the gateway. This field is not applicable to the Lite API.
    Type string
    (string) - Indicates whether the type of Proxy gateway. Returned values are: PROXYCHAIN, ZIA, or ECSELF
    Description string
    (string) - Additional details about the Proxy gateway
    FailClosed bool
    (Boolean) - Indicates whether fail close is enabled to drop the traffic or disabled to allow the traffic when both primary and secondary proxies defined in this gateway are unreachable.
    Id int
    (string) A unique identifier for the secondary proxy gateway
    LastModifiedBies []GetForwardingProxyGatewayLastModifiedBy
    (list) - Information about the admin user that last modified the Proxy gateway
    LastModifiedTime int
    (int) - Timestamp when the ZPA gateway was last modified
    Name string
    (string) The configured name for the secondary proxy gateway
    PrimaryProxies []GetForwardingProxyGatewayPrimaryProxy
    (Set of String) - The primary proxy for the gateway. This field is not applicable to the Lite API.
    SecondaryProxies []GetForwardingProxyGatewaySecondaryProxy
    () - The secondary proxy for the gateway. This field is not applicable to the Lite API.
    Type string
    (string) - Indicates whether the type of Proxy gateway. Returned values are: PROXYCHAIN, ZIA, or ECSELF
    description String
    (string) - Additional details about the Proxy gateway
    failClosed Boolean
    (Boolean) - Indicates whether fail close is enabled to drop the traffic or disabled to allow the traffic when both primary and secondary proxies defined in this gateway are unreachable.
    id Integer
    (string) A unique identifier for the secondary proxy gateway
    lastModifiedBies List<GetForwardingProxyGatewayLastModifiedBy>
    (list) - Information about the admin user that last modified the Proxy gateway
    lastModifiedTime Integer
    (int) - Timestamp when the ZPA gateway was last modified
    name String
    (string) The configured name for the secondary proxy gateway
    primaryProxies List<GetForwardingProxyGatewayPrimaryProxy>
    (Set of String) - The primary proxy for the gateway. This field is not applicable to the Lite API.
    secondaryProxies List<GetForwardingProxyGatewaySecondaryProxy>
    () - The secondary proxy for the gateway. This field is not applicable to the Lite API.
    type String
    (string) - Indicates whether the type of Proxy gateway. Returned values are: PROXYCHAIN, ZIA, or ECSELF
    description string
    (string) - Additional details about the Proxy gateway
    failClosed boolean
    (Boolean) - Indicates whether fail close is enabled to drop the traffic or disabled to allow the traffic when both primary and secondary proxies defined in this gateway are unreachable.
    id number
    (string) A unique identifier for the secondary proxy gateway
    lastModifiedBies GetForwardingProxyGatewayLastModifiedBy[]
    (list) - Information about the admin user that last modified the Proxy gateway
    lastModifiedTime number
    (int) - Timestamp when the ZPA gateway was last modified
    name string
    (string) The configured name for the secondary proxy gateway
    primaryProxies GetForwardingProxyGatewayPrimaryProxy[]
    (Set of String) - The primary proxy for the gateway. This field is not applicable to the Lite API.
    secondaryProxies GetForwardingProxyGatewaySecondaryProxy[]
    () - The secondary proxy for the gateway. This field is not applicable to the Lite API.
    type string
    (string) - Indicates whether the type of Proxy gateway. Returned values are: PROXYCHAIN, ZIA, or ECSELF
    description str
    (string) - Additional details about the Proxy gateway
    fail_closed bool
    (Boolean) - Indicates whether fail close is enabled to drop the traffic or disabled to allow the traffic when both primary and secondary proxies defined in this gateway are unreachable.
    id int
    (string) A unique identifier for the secondary proxy gateway
    last_modified_bies Sequence[GetForwardingProxyGatewayLastModifiedBy]
    (list) - Information about the admin user that last modified the Proxy gateway
    last_modified_time int
    (int) - Timestamp when the ZPA gateway was last modified
    name str
    (string) The configured name for the secondary proxy gateway
    primary_proxies Sequence[GetForwardingProxyGatewayPrimaryProxy]
    (Set of String) - The primary proxy for the gateway. This field is not applicable to the Lite API.
    secondary_proxies Sequence[GetForwardingProxyGatewaySecondaryProxy]
    () - The secondary proxy for the gateway. This field is not applicable to the Lite API.
    type str
    (string) - Indicates whether the type of Proxy gateway. Returned values are: PROXYCHAIN, ZIA, or ECSELF
    description String
    (string) - Additional details about the Proxy gateway
    failClosed Boolean
    (Boolean) - Indicates whether fail close is enabled to drop the traffic or disabled to allow the traffic when both primary and secondary proxies defined in this gateway are unreachable.
    id Number
    (string) A unique identifier for the secondary proxy gateway
    lastModifiedBies List<Property Map>
    (list) - Information about the admin user that last modified the Proxy gateway
    lastModifiedTime Number
    (int) - Timestamp when the ZPA gateway was last modified
    name String
    (string) The configured name for the secondary proxy gateway
    primaryProxies List<Property Map>
    (Set of String) - The primary proxy for the gateway. This field is not applicable to the Lite API.
    secondaryProxies List<Property Map>
    () - The secondary proxy for the gateway. This field is not applicable to the Lite API.
    type String
    (string) - Indicates whether the type of Proxy gateway. Returned values are: PROXYCHAIN, ZIA, or ECSELF

    Supporting Types

    GetForwardingProxyGatewayLastModifiedBy

    Extensions Dictionary<string, string>
    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    Extensions map[string]string
    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    extensions Map<String,String>
    id Integer
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.
    extensions {[key: string]: string}
    id number
    The ID of the forwarding control Proxy Gateway resource.
    name string
    The name of the forwarding control Proxy Gateway to be exported.
    extensions Mapping[str, str]
    id int
    The ID of the forwarding control Proxy Gateway resource.
    name str
    The name of the forwarding control Proxy Gateway to be exported.
    extensions Map<String>
    id Number
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.

    GetForwardingProxyGatewayPrimaryProxy

    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    id Integer
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.
    id number
    The ID of the forwarding control Proxy Gateway resource.
    name string
    The name of the forwarding control Proxy Gateway to be exported.
    id int
    The ID of the forwarding control Proxy Gateway resource.
    name str
    The name of the forwarding control Proxy Gateway to be exported.
    id Number
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.

    GetForwardingProxyGatewaySecondaryProxy

    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    Id int
    The ID of the forwarding control Proxy Gateway resource.
    Name string
    The name of the forwarding control Proxy Gateway to be exported.
    id Integer
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.
    id number
    The ID of the forwarding control Proxy Gateway resource.
    name string
    The name of the forwarding control Proxy Gateway to be exported.
    id int
    The ID of the forwarding control Proxy Gateway resource.
    name str
    The name of the forwarding control Proxy Gateway to be exported.
    id Number
    The ID of the forwarding control Proxy Gateway resource.
    name String
    The name of the forwarding control Proxy Gateway to be exported.

    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
    zscaler/pulumi-zia