Docs Packages
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getLocationLite
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zscaler/pulumi-zia

zia.getLocationLite

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zscaler/pulumi-zia

    Use the zia_location_lite data source to get information about a location in lite mode option available in the Zscaler Internet Access. This data source can be used to retrieve the Road Warrior location to then associated with one of the following resources: zia.URLFilteringRules, zia.FirewallFilteringRule and ``zia.DLPWebRules`

    import * as pulumi from "@pulumi/pulumi";
import * as zia from "@pulumi/zia";

const this = zia.getLocationLite({
    name: "Road Warrior",
});

    import pulumi
import pulumi_zia as zia

this = zia.get_location_lite(name="Road Warrior")

    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.GetLocationLite(ctx, &zia.GetLocationLiteArgs{
			Name: pulumi.StringRef("Road Warrior"),
		}, 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.GetLocationLite.Invoke(new()
    {
        Name = "Road Warrior",
    });

});

    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.GetLocationLiteArgs;
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.getLocationLite(GetLocationLiteArgs.builder()
            .name("Road Warrior")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      Function: zia:getLocationLite
      Arguments:
        name: Road Warrior

    Using getLocationLite

    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 getLocationLite(args: GetLocationLiteArgs, opts?: InvokeOptions): Promise<GetLocationLiteResult>
function getLocationLiteOutput(args: GetLocationLiteOutputArgs, opts?: InvokeOptions): Output<GetLocationLiteResult>
    def get_location_lite(digest_auth_enabled: Optional[bool] = None,
                      kerberos_auth: Optional[bool] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLocationLiteResult
def get_location_lite_output(digest_auth_enabled: Optional[pulumi.Input[bool]] = None,
                      kerberos_auth: Optional[pulumi.Input[bool]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLocationLiteResult]
    func GetLocationLite(ctx *Context, args *GetLocationLiteArgs, opts ...InvokeOption) (*GetLocationLiteResult, error)
func GetLocationLiteOutput(ctx *Context, args *GetLocationLiteOutputArgs, opts ...InvokeOption) GetLocationLiteResultOutput

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

    public static class GetLocationLite 
{
    public static Task<GetLocationLiteResult> InvokeAsync(GetLocationLiteArgs args, InvokeOptions? opts = null)
    public static Output<GetLocationLiteResult> Invoke(GetLocationLiteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLocationLiteResult> getLocationLite(GetLocationLiteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    DigestAuthEnabled bool
    (Boolean)
    KerberosAuth bool
    (Boolean)
    Name string
    Location group name
    DigestAuthEnabled bool
    (Boolean)
    KerberosAuth bool
    (Boolean)
    Name string
    Location group name
    digestAuthEnabled Boolean
    (Boolean)
    kerberosAuth Boolean
    (Boolean)
    name String
    Location group name
    digestAuthEnabled boolean
    (Boolean)
    kerberosAuth boolean
    (Boolean)
    name string
    Location group name
    digest_auth_enabled bool
    (Boolean)
    kerberos_auth bool
    (Boolean)
    name str
    Location group name
    digestAuthEnabled Boolean
    (Boolean)
    kerberosAuth Boolean
    (Boolean)
    name String
    Location group name

    getLocationLite Result

    The following output properties are available:

    AupBlockInternetUntilAccepted bool
    (Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
    AupEnabled bool
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    AupForceSslInspection bool
    (Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
    CautionEnabled bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    EcLocation bool
    (Boolean)
    Id int
    IpsControl bool
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    Ipv6Enabled bool
    (Number) If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.
    OfwEnabled bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    Other6SubLocation bool
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other6 and it can be renamed, if required. This field is applicable only if ipv6Enabled is set is true
    OtherSubLocation bool
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other and it can be renamed, if required.
    ParentId int
    (Number) - Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: SUB
    SurrogateIp bool
    (Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
    SurrogateIpEnforcedForKnownBrowsers bool
    (Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
    Tz string
    (String) Timezone of the location. If not specified, it defaults to GMT.
    XffForwardEnabled bool
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    ZappSslScanEnabled bool
    (Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
    DigestAuthEnabled bool
    (Boolean)
    KerberosAuth bool
    (Boolean)
    Name string
    AupBlockInternetUntilAccepted bool
    (Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
    AupEnabled bool
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    AupForceSslInspection bool
    (Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
    CautionEnabled bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    EcLocation bool
    (Boolean)
    Id int
    IpsControl bool
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    Ipv6Enabled bool
    (Number) If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.
    OfwEnabled bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    Other6SubLocation bool
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other6 and it can be renamed, if required. This field is applicable only if ipv6Enabled is set is true
    OtherSubLocation bool
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other and it can be renamed, if required.
    ParentId int
    (Number) - Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: SUB
    SurrogateIp bool
    (Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
    SurrogateIpEnforcedForKnownBrowsers bool
    (Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
    Tz string
    (String) Timezone of the location. If not specified, it defaults to GMT.
    XffForwardEnabled bool
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    ZappSslScanEnabled bool
    (Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
    DigestAuthEnabled bool
    (Boolean)
    KerberosAuth bool
    (Boolean)
    Name string
    aupBlockInternetUntilAccepted Boolean
    (Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
    aupEnabled Boolean
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    aupForceSslInspection Boolean
    (Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
    cautionEnabled Boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    ecLocation Boolean
    (Boolean)
    id Integer
    ipsControl Boolean
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    ipv6Enabled Boolean
    (Number) If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.
    ofwEnabled Boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    other6SubLocation Boolean
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other6 and it can be renamed, if required. This field is applicable only if ipv6Enabled is set is true
    otherSubLocation Boolean
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other and it can be renamed, if required.
    parentId Integer
    (Number) - Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: SUB
    surrogateIp Boolean
    (Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
    surrogateIpEnforcedForKnownBrowsers Boolean
    (Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
    tz String
    (String) Timezone of the location. If not specified, it defaults to GMT.
    xffForwardEnabled Boolean
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    zappSslScanEnabled Boolean
    (Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
    digestAuthEnabled Boolean
    (Boolean)
    kerberosAuth Boolean
    (Boolean)
    name String
    aupBlockInternetUntilAccepted boolean
    (Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
    aupEnabled boolean
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    aupForceSslInspection boolean
    (Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
    cautionEnabled boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    ecLocation boolean
    (Boolean)
    id number
    ipsControl boolean
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    ipv6Enabled boolean
    (Number) If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.
    ofwEnabled boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    other6SubLocation boolean
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other6 and it can be renamed, if required. This field is applicable only if ipv6Enabled is set is true
    otherSubLocation boolean
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other and it can be renamed, if required.
    parentId number
    (Number) - Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: SUB
    surrogateIp boolean
    (Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
    surrogateIpEnforcedForKnownBrowsers boolean
    (Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
    tz string
    (String) Timezone of the location. If not specified, it defaults to GMT.
    xffForwardEnabled boolean
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    zappSslScanEnabled boolean
    (Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
    digestAuthEnabled boolean
    (Boolean)
    kerberosAuth boolean
    (Boolean)
    name string
    aup_block_internet_until_accepted bool
    (Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
    aup_enabled bool
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    aup_force_ssl_inspection bool
    (Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
    caution_enabled bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    ec_location bool
    (Boolean)
    id int
    ips_control bool
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    ipv6_enabled bool
    (Number) If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.
    ofw_enabled bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    other6_sub_location bool
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other6 and it can be renamed, if required. This field is applicable only if ipv6Enabled is set is true
    other_sub_location bool
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other and it can be renamed, if required.
    parent_id int
    (Number) - Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: SUB
    surrogate_ip bool
    (Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
    surrogate_ip_enforced_for_known_browsers bool
    (Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
    tz str
    (String) Timezone of the location. If not specified, it defaults to GMT.
    xff_forward_enabled bool
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    zapp_ssl_scan_enabled bool
    (Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
    digest_auth_enabled bool
    (Boolean)
    kerberos_auth bool
    (Boolean)
    name str
    aupBlockInternetUntilAccepted Boolean
    (Boolean) For First Time AUP Behavior, Block Internet Access. When set, all internet access (including non-HTTP traffic) is disabled until the user accepts the AUP.
    aupEnabled Boolean
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    aupForceSslInspection Boolean
    (Boolean) For First Time AUP Behavior, Force SSL Inspection. When set, Zscaler will force SSL Inspection in order to enforce AUP for HTTPS traffic.
    cautionEnabled Boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    ecLocation Boolean
    (Boolean)
    id Number
    ipsControl Boolean
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    ipv6Enabled Boolean
    (Number) If set to true, IPv6 is enabled for the location and IPv6 traffic from the location can be forwarded to the Zscaler service to enforce security policies.
    ofwEnabled Boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    other6SubLocation Boolean
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv6 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other6 and it can be renamed, if required. This field is applicable only if ipv6Enabled is set is true
    otherSubLocation Boolean
    (Boolean) If set to true, indicates that this is a default sub-location created by the Zscaler service to accommodate IPv4 addresses that are not part of any user-defined sub-locations. The default sub-location is created with the name Other and it can be renamed, if required.
    parentId Number
    (Number) - Parent Location ID. If this ID does not exist or is 0, it is implied that it is a parent location. Otherwise, it is a sub-location whose parent has this ID. x-applicableTo: SUB
    surrogateIp Boolean
    (Boolean) Enable Surrogate IP. When set to true, users are mapped to internal device IP addresses.
    surrogateIpEnforcedForKnownBrowsers Boolean
    (Boolean) Enforce Surrogate IP for Known Browsers. When set to true, IP Surrogate is enforced for all known browsers.
    tz String
    (String) Timezone of the location. If not specified, it defaults to GMT.
    xffForwardEnabled Boolean
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    zappSslScanEnabled Boolean
    (Boolean) This parameter was deprecated and no longer has an effect on SSL policy. It remains supported in the API payload in order to maintain backwards compatibility with existing scripts, but it will be removed in future.
    digestAuthEnabled Boolean
    (Boolean)
    kerberosAuth Boolean
    (Boolean)
    name String

    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 v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
    zscaler/pulumi-zia