Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getLocationManagement
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

zia.getLocationManagement

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

    Use the zia_location_management data source to get information about a location resource available in the Zscaler Internet Access Location Management. This resource can then be referenced in multiple other resources, such as URL Filtering Rules, Firewall rules etc.

    Example Usage

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

const example = zia.getLocationManagement({
    name: "San Jose",
});

    import pulumi
import pulumi_zia as zia

example = zia.get_location_management(name="San Jose")

    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.LookupLocationManagement(ctx, &zia.LookupLocationManagementArgs{
			Name: pulumi.StringRef("San Jose"),
		}, 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 example = Zia.GetLocationManagement.Invoke(new()
    {
        Name = "San Jose",
    });

});

    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.GetLocationManagementArgs;
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 example = ZiaFunctions.getLocationManagement(GetLocationManagementArgs.builder()
            .name("San Jose")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: zia:getLocationManagement
      Arguments:
        name: San Jose

    Using getLocationManagement

    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 getLocationManagement(args: GetLocationManagementArgs, opts?: InvokeOptions): Promise<GetLocationManagementResult>
function getLocationManagementOutput(args: GetLocationManagementOutputArgs, opts?: InvokeOptions): Output<GetLocationManagementResult>
    def get_location_management(basic_auth_enabled: Optional[bool] = None,
                            id: Optional[int] = None,
                            name: Optional[str] = None,
                            parent_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetLocationManagementResult
def get_location_management_output(basic_auth_enabled: Optional[pulumi.Input[bool]] = None,
                            id: Optional[pulumi.Input[int]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            parent_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetLocationManagementResult]
    func LookupLocationManagement(ctx *Context, args *LookupLocationManagementArgs, opts ...InvokeOption) (*LookupLocationManagementResult, error)
func LookupLocationManagementOutput(ctx *Context, args *LookupLocationManagementOutputArgs, opts ...InvokeOption) LookupLocationManagementResultOutput

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

    public static class GetLocationManagement 
{
    public static Task<GetLocationManagementResult> InvokeAsync(GetLocationManagementArgs args, InvokeOptions? opts = null)
    public static Output<GetLocationManagementResult> Invoke(GetLocationManagementInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLocationManagementResult> getLocationManagement(GetLocationManagementArgs args, InvokeOptions options)
public static Output<GetLocationManagementResult> getLocationManagement(GetLocationManagementArgs args, InvokeOptions options)

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

    The following arguments are supported:

    BasicAuthEnabled bool
    Id int
    The ID of the location to be exported.
    Name string
    The name of the location to be exported.
    ParentName string
    BasicAuthEnabled bool
    Id int
    The ID of the location to be exported.
    Name string
    The name of the location to be exported.
    ParentName string
    basicAuthEnabled Boolean
    id Integer
    The ID of the location to be exported.
    name String
    The name of the location to be exported.
    parentName String
    basicAuthEnabled boolean
    id number
    The ID of the location to be exported.
    name string
    The name of the location to be exported.
    parentName string
    basic_auth_enabled bool
    id int
    The ID of the location to be exported.
    name str
    The name of the location to be exported.
    parent_name str
    basicAuthEnabled Boolean
    id Number
    The ID of the location to be exported.
    name String
    The name of the location to be exported.
    parentName String

    getLocationManagement 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.
    AupTimeoutInDays int
    (Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
    AuthRequired bool
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    BasicAuthEnabled bool
    CautionEnabled bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    Country string
    (String) Country
    Description string
    (String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
    DigestAuthEnabled bool
    DisplayTimeUnit string
    (String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
    DnBandwidth int
    (Number) Download bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    IdleTimeInMinutes int
    (Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
    IotDiscoveryEnabled bool
    IpAddresses List<string>
    (List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).
    IpsControl bool
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    KerberosAuthEnabled bool
    OfwEnabled bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    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
    Ports string
    (String) IP ports that are associated with the location.
    Profile string
    (String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to Unassigned.
    SslScanEnabled 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.
    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.
    SurrogateRefreshTimeInMinutes int
    (Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
    SurrogateRefreshTimeUnit string
    (String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
    Tz string
    (String) Timezone of the location. If not specified, it defaults to GMT.
    UpBandwidth int
    (Number) Upload bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    VpnCredentials List<zscaler.PulumiPackage.Zia.Outputs.GetLocationManagementVpnCredential>
    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.
    Id int
    (Number) Identifier that uniquely identifies an entity
    Name string
    (String) The configured name of the entity
    ParentName 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.
    AupTimeoutInDays int
    (Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
    AuthRequired bool
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    BasicAuthEnabled bool
    CautionEnabled bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    Country string
    (String) Country
    Description string
    (String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
    DigestAuthEnabled bool
    DisplayTimeUnit string
    (String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
    DnBandwidth int
    (Number) Download bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    IdleTimeInMinutes int
    (Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
    IotDiscoveryEnabled bool
    IpAddresses []string
    (List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).
    IpsControl bool
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    KerberosAuthEnabled bool
    OfwEnabled bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    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
    Ports string
    (String) IP ports that are associated with the location.
    Profile string
    (String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to Unassigned.
    SslScanEnabled 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.
    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.
    SurrogateRefreshTimeInMinutes int
    (Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
    SurrogateRefreshTimeUnit string
    (String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
    Tz string
    (String) Timezone of the location. If not specified, it defaults to GMT.
    UpBandwidth int
    (Number) Upload bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    VpnCredentials []GetLocationManagementVpnCredential
    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.
    Id int
    (Number) Identifier that uniquely identifies an entity
    Name string
    (String) The configured name of the entity
    ParentName 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.
    aupTimeoutInDays Integer
    (Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
    authRequired Boolean
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    basicAuthEnabled Boolean
    cautionEnabled Boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    country String
    (String) Country
    description String
    (String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
    digestAuthEnabled Boolean
    displayTimeUnit String
    (String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
    dnBandwidth Integer
    (Number) Download bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    idleTimeInMinutes Integer
    (Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
    iotDiscoveryEnabled Boolean
    ipAddresses List<String>
    (List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).
    ipsControl Boolean
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    kerberosAuthEnabled Boolean
    ofwEnabled Boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    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
    ports String
    (String) IP ports that are associated with the location.
    profile String
    (String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to Unassigned.
    sslScanEnabled 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.
    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.
    surrogateRefreshTimeInMinutes Integer
    (Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
    surrogateRefreshTimeUnit String
    (String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
    tz String
    (String) Timezone of the location. If not specified, it defaults to GMT.
    upBandwidth Integer
    (Number) Upload bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    vpnCredentials List<GetLocationManagementVpnCredential>
    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.
    id Integer
    (Number) Identifier that uniquely identifies an entity
    name String
    (String) The configured name of the entity
    parentName 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.
    aupTimeoutInDays number
    (Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
    authRequired boolean
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    basicAuthEnabled boolean
    cautionEnabled boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    country string
    (String) Country
    description string
    (String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
    digestAuthEnabled boolean
    displayTimeUnit string
    (String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
    dnBandwidth number
    (Number) Download bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    idleTimeInMinutes number
    (Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
    iotDiscoveryEnabled boolean
    ipAddresses string[]
    (List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).
    ipsControl boolean
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    kerberosAuthEnabled boolean
    ofwEnabled boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    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
    ports string
    (String) IP ports that are associated with the location.
    profile string
    (String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to Unassigned.
    sslScanEnabled 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.
    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.
    surrogateRefreshTimeInMinutes number
    (Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
    surrogateRefreshTimeUnit string
    (String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
    tz string
    (String) Timezone of the location. If not specified, it defaults to GMT.
    upBandwidth number
    (Number) Upload bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    vpnCredentials GetLocationManagementVpnCredential[]
    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.
    id number
    (Number) Identifier that uniquely identifies an entity
    name string
    (String) The configured name of the entity
    parentName 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.
    aup_timeout_in_days int
    (Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
    auth_required bool
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    basic_auth_enabled bool
    caution_enabled bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    country str
    (String) Country
    description str
    (String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
    digest_auth_enabled bool
    display_time_unit str
    (String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
    dn_bandwidth int
    (Number) Download bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    idle_time_in_minutes int
    (Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
    iot_discovery_enabled bool
    ip_addresses Sequence[str]
    (List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).
    ips_control bool
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    kerberos_auth_enabled bool
    ofw_enabled bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    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
    ports str
    (String) IP ports that are associated with the location.
    profile str
    (String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to Unassigned.
    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.
    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.
    surrogate_refresh_time_in_minutes int
    (Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
    surrogate_refresh_time_unit str
    (String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
    tz str
    (String) Timezone of the location. If not specified, it defaults to GMT.
    up_bandwidth int
    (Number) Upload bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    vpn_credentials Sequence[GetLocationManagementVpnCredential]
    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.
    id int
    (Number) Identifier that uniquely identifies an entity
    name str
    (String) The configured name of the entity
    parent_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.
    aupTimeoutInDays Number
    (Number) Custom AUP Frequency. Refresh time (in days) to re-validate the AUP.
    authRequired Boolean
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    basicAuthEnabled Boolean
    cautionEnabled Boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    country String
    (String) Country
    description String
    (String) Additional notes or information regarding the location or sub-location. The description cannot exceed 1024 characters.
    digestAuthEnabled Boolean
    displayTimeUnit String
    (String) Display Time Unit. The time unit to display for IP Surrogate idle time to disassociation.
    dnBandwidth Number
    (Number) Download bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    idleTimeInMinutes Number
    (Number) Idle Time to Disassociation. The user mapping idle time (in minutes) is required if a Surrogate IP is enabled.
    iotDiscoveryEnabled Boolean
    ipAddresses List<String>
    (List of String) For locations: IP addresses of the egress points that are provisioned in the Zscaler Cloud. Each entry is a single IP address (e.g., 238.10.33.9). For sub-locations: Egress, internal, or GRE tunnel IP addresses. Each entry is either a single IP address, CIDR (e.g., 10.10.33.0/24), or range (e.g., 10.10.33.1-10.10.33.10)).
    ipsControl Boolean
    (Boolean) Enable IPS Control. When set to true, IPS Control is enabled for the location if Firewall is enabled.
    kerberosAuthEnabled Boolean
    ofwEnabled Boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    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
    ports String
    (String) IP ports that are associated with the location.
    profile String
    (String) Profile tag that specifies the location traffic type. If not specified, this tag defaults to Unassigned.
    sslScanEnabled 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.
    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.
    surrogateRefreshTimeInMinutes Number
    (Number) Refresh Time for re-validation of Surrogacy. The surrogate refresh time (in minutes) to re-validate the IP surrogates.
    surrogateRefreshTimeUnit String
    (String) Display Refresh Time Unit. The time unit to display for refresh time for re-validation of surrogacy.
    tz String
    (String) Timezone of the location. If not specified, it defaults to GMT.
    upBandwidth Number
    (Number) Upload bandwidth in bytes. The value 0 implies no Bandwidth Control enforcement.
    vpnCredentials List<Property Map>
    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.
    id Number
    (Number) Identifier that uniquely identifies an entity
    name String
    (String) The configured name of the entity
    parentName String

    Supporting Types

    GetLocationManagementVpnCredential

    Comments string
    (String) Additional information about this VPN credential. Additional information about this VPN credential.
    Fqdn string
    (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
    Id int
    The ID of the location to be exported.
    Locations List<zscaler.PulumiPackage.Zia.Inputs.GetLocationManagementVpnCredentialLocation>
    (List of Object)
    ManagedBies List<zscaler.PulumiPackage.Zia.Inputs.GetLocationManagementVpnCredentialManagedBy>
    (List of Object)
    PreSharedKey string
    (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
    Type string
    (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
    Comments string
    (String) Additional information about this VPN credential. Additional information about this VPN credential.
    Fqdn string
    (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
    Id int
    The ID of the location to be exported.
    Locations []GetLocationManagementVpnCredentialLocation
    (List of Object)
    ManagedBies []GetLocationManagementVpnCredentialManagedBy
    (List of Object)
    PreSharedKey string
    (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
    Type string
    (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
    comments String
    (String) Additional information about this VPN credential. Additional information about this VPN credential.
    fqdn String
    (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
    id Integer
    The ID of the location to be exported.
    locations List<GetLocationManagementVpnCredentialLocation>
    (List of Object)
    managedBies List<GetLocationManagementVpnCredentialManagedBy>
    (List of Object)
    preSharedKey String
    (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
    type String
    (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
    comments string
    (String) Additional information about this VPN credential. Additional information about this VPN credential.
    fqdn string
    (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
    id number
    The ID of the location to be exported.
    locations GetLocationManagementVpnCredentialLocation[]
    (List of Object)
    managedBies GetLocationManagementVpnCredentialManagedBy[]
    (List of Object)
    preSharedKey string
    (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
    type string
    (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
    comments str
    (String) Additional information about this VPN credential. Additional information about this VPN credential.
    fqdn str
    (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
    id int
    The ID of the location to be exported.
    locations Sequence[GetLocationManagementVpnCredentialLocation]
    (List of Object)
    managed_bies Sequence[GetLocationManagementVpnCredentialManagedBy]
    (List of Object)
    pre_shared_key str
    (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
    type str
    (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
    comments String
    (String) Additional information about this VPN credential. Additional information about this VPN credential.
    fqdn String
    (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
    id Number
    The ID of the location to be exported.
    locations List<Property Map>
    (List of Object)
    managedBies List<Property Map>
    (List of Object)
    preSharedKey String
    (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
    type String
    (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

    GetLocationManagementVpnCredentialLocation

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

    GetLocationManagementVpnCredentialManagedBy

    Extensions Dictionary<string, string>
    (Map of String)
    Id int
    The ID of the location to be exported.
    Name string
    The name of the location to be exported.
    Extensions map[string]string
    (Map of String)
    Id int
    The ID of the location to be exported.
    Name string
    The name of the location to be exported.
    extensions Map<String,String>
    (Map of String)
    id Integer
    The ID of the location to be exported.
    name String
    The name of the location to be exported.
    extensions {[key: string]: string}
    (Map of String)
    id number
    The ID of the location to be exported.
    name string
    The name of the location to be exported.
    extensions Mapping[str, str]
    (Map of String)
    id int
    The ID of the location to be exported.
    name str
    The name of the location to be exported.
    extensions Map<String>
    (Map of String)
    id Number
    The ID of the location to be exported.
    name String
    The name of the location 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 v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zia