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

zia.getForwardingControlProxies

Explore with Pulumi AI

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

    Use the zia_forwarding_control_proxies data source to get information about a third-party proxy service available in the Zscaler Internet Access.

    Example Usage

    Retrieve By Name

    data "zia_forwarding_control_proxies" "this" {
        name = "Proxy01"
    }
    

    Retrieve By ID

    data "zia_forwarding_control_proxies" "this" {
        id = "18492370"
    }
    

    Using getForwardingControlProxies

    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 getForwardingControlProxies(args: GetForwardingControlProxiesArgs, opts?: InvokeOptions): Promise<GetForwardingControlProxiesResult>
    function getForwardingControlProxiesOutput(args: GetForwardingControlProxiesOutputArgs, opts?: InvokeOptions): Output<GetForwardingControlProxiesResult>
    def get_forwarding_control_proxies(id: Optional[int] = None,
                                       name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetForwardingControlProxiesResult
    def get_forwarding_control_proxies_output(id: Optional[pulumi.Input[int]] = None,
                                       name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetForwardingControlProxiesResult]
    func LookupForwardingControlProxies(ctx *Context, args *LookupForwardingControlProxiesArgs, opts ...InvokeOption) (*LookupForwardingControlProxiesResult, error)
    func LookupForwardingControlProxiesOutput(ctx *Context, args *LookupForwardingControlProxiesOutputArgs, opts ...InvokeOption) LookupForwardingControlProxiesResultOutput

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

    public static class GetForwardingControlProxies 
    {
        public static Task<GetForwardingControlProxiesResult> InvokeAsync(GetForwardingControlProxiesArgs args, InvokeOptions? opts = null)
        public static Output<GetForwardingControlProxiesResult> Invoke(GetForwardingControlProxiesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetForwardingControlProxiesResult> getForwardingControlProxies(GetForwardingControlProxiesArgs args, InvokeOptions options)
    public static Output<GetForwardingControlProxiesResult> getForwardingControlProxies(GetForwardingControlProxiesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zia:index/getForwardingControlProxies:getForwardingControlProxies
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id int
    Unique identifier for the third-party proxy services
    Name string
    Proxy name for the third-party proxy services
    Id int
    Unique identifier for the third-party proxy services
    Name string
    Proxy name for the third-party proxy services
    id Integer
    Unique identifier for the third-party proxy services
    name String
    Proxy name for the third-party proxy services
    id number
    Unique identifier for the third-party proxy services
    name string
    Proxy name for the third-party proxy services
    id int
    Unique identifier for the third-party proxy services
    name str
    Proxy name for the third-party proxy services
    id Number
    Unique identifier for the third-party proxy services
    name String
    Proxy name for the third-party proxy services

    getForwardingControlProxies Result

    The following output properties are available:

    Address string
    (String) The IP address or the FQDN of the third-party proxy service
    Base64EncodeXauHeader bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    Certs List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingControlProxiesCert>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    Description string
    (String) Additional notes or information
    Id int
    (Integer) Identifier that uniquely identifies the certificate
    InsertXauHeader bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetForwardingControlProxiesLastModifiedBy>
    LastModifiedTime int
    Name string
    Port int
    (integer) The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    Type string
    (String) Gateway type. Returned values: PROXYCHAIN, ZIA, ECSELF
    Address string
    (String) The IP address or the FQDN of the third-party proxy service
    Base64EncodeXauHeader bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    Certs []GetForwardingControlProxiesCert
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    Description string
    (String) Additional notes or information
    Id int
    (Integer) Identifier that uniquely identifies the certificate
    InsertXauHeader bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    LastModifiedBies []GetForwardingControlProxiesLastModifiedBy
    LastModifiedTime int
    Name string
    Port int
    (integer) The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    Type string
    (String) Gateway type. Returned values: PROXYCHAIN, ZIA, ECSELF
    address String
    (String) The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader Boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs List<GetForwardingControlProxiesCert>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description String
    (String) Additional notes or information
    id Integer
    (Integer) Identifier that uniquely identifies the certificate
    insertXauHeader Boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    lastModifiedBies List<GetForwardingControlProxiesLastModifiedBy>
    lastModifiedTime Integer
    name String
    port Integer
    (integer) The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type String
    (String) Gateway type. Returned values: PROXYCHAIN, ZIA, ECSELF
    address string
    (String) The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs GetForwardingControlProxiesCert[]
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description string
    (String) Additional notes or information
    id number
    (Integer) Identifier that uniquely identifies the certificate
    insertXauHeader boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    lastModifiedBies GetForwardingControlProxiesLastModifiedBy[]
    lastModifiedTime number
    name string
    port number
    (integer) The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type string
    (String) Gateway type. Returned values: PROXYCHAIN, ZIA, ECSELF
    address str
    (String) The IP address or the FQDN of the third-party proxy service
    base64_encode_xau_header bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs Sequence[GetForwardingControlProxiesCert]
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description str
    (String) Additional notes or information
    id int
    (Integer) Identifier that uniquely identifies the certificate
    insert_xau_header bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    last_modified_bies Sequence[GetForwardingControlProxiesLastModifiedBy]
    last_modified_time int
    name str
    port int
    (integer) The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type str
    (String) Gateway type. Returned values: PROXYCHAIN, ZIA, ECSELF
    address String
    (String) The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader Boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs List<Property Map>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description String
    (String) Additional notes or information
    id Number
    (Integer) Identifier that uniquely identifies the certificate
    insertXauHeader Boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    lastModifiedBies List<Property Map>
    lastModifiedTime Number
    name String
    port Number
    (integer) The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type String
    (String) Gateway type. Returned values: PROXYCHAIN, ZIA, ECSELF

    Supporting Types

    GetForwardingControlProxiesCert

    Extensions Dictionary<string, string>
    ExternalId string
    The configured name of the entity
    Id int
    Unique identifier for the third-party proxy services
    Name string
    Proxy name for the third-party proxy services
    Extensions map[string]string
    ExternalId string
    The configured name of the entity
    Id int
    Unique identifier for the third-party proxy services
    Name string
    Proxy name for the third-party proxy services
    extensions Map<String,String>
    externalId String
    The configured name of the entity
    id Integer
    Unique identifier for the third-party proxy services
    name String
    Proxy name for the third-party proxy services
    extensions {[key: string]: string}
    externalId string
    The configured name of the entity
    id number
    Unique identifier for the third-party proxy services
    name string
    Proxy name for the third-party proxy services
    extensions Mapping[str, str]
    external_id str
    The configured name of the entity
    id int
    Unique identifier for the third-party proxy services
    name str
    Proxy name for the third-party proxy services
    extensions Map<String>
    externalId String
    The configured name of the entity
    id Number
    Unique identifier for the third-party proxy services
    name String
    Proxy name for the third-party proxy services

    GetForwardingControlProxiesLastModifiedBy

    Extensions Dictionary<string, string>
    ExternalId string
    The configured name of the entity
    Id int
    Unique identifier for the third-party proxy services
    Name string
    Proxy name for the third-party proxy services
    Extensions map[string]string
    ExternalId string
    The configured name of the entity
    Id int
    Unique identifier for the third-party proxy services
    Name string
    Proxy name for the third-party proxy services
    extensions Map<String,String>
    externalId String
    The configured name of the entity
    id Integer
    Unique identifier for the third-party proxy services
    name String
    Proxy name for the third-party proxy services
    extensions {[key: string]: string}
    externalId string
    The configured name of the entity
    id number
    Unique identifier for the third-party proxy services
    name string
    Proxy name for the third-party proxy services
    extensions Mapping[str, str]
    external_id str
    The configured name of the entity
    id int
    Unique identifier for the third-party proxy services
    name str
    Proxy name for the third-party proxy services
    extensions Map<String>
    externalId String
    The configured name of the entity
    id Number
    Unique identifier for the third-party proxy services
    name String
    Proxy name for the third-party proxy services

    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