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. getLocationGroups
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

zia.getLocationGroups

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

    Use the zia_location_groups data source to get information about a location group option available in the Zscaler Internet Access.

    data "zia_location_groups" "example"{
    name = "Corporate User Traffic Group"
}

    data "zia_location_groups" "example"{
    name = "Guest Wifi Group"
}

    data "zia_location_groups" "example"{
    name = "IoT Traffic Group"
}

    data "zia_location_groups" "example"{
    name = "Server Traffic Group"
}

    data "zia_location_groups" "example"{
    name = "Server Traffic Group"
}

    Using getLocationGroups

    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 getLocationGroups(args: GetLocationGroupsArgs, opts?: InvokeOptions): Promise<GetLocationGroupsResult>
function getLocationGroupsOutput(args: GetLocationGroupsOutputArgs, opts?: InvokeOptions): Output<GetLocationGroupsResult>
    def get_location_groups(dynamic_location_group_criterias: Optional[Sequence[GetLocationGroupsDynamicLocationGroupCriteria]] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetLocationGroupsResult
def get_location_groups_output(dynamic_location_group_criterias: Optional[pulumi.Input[Sequence[pulumi.Input[GetLocationGroupsDynamicLocationGroupCriteriaArgs]]]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetLocationGroupsResult]
    func GetLocationGroups(ctx *Context, args *GetLocationGroupsArgs, opts ...InvokeOption) (*GetLocationGroupsResult, error)
func GetLocationGroupsOutput(ctx *Context, args *GetLocationGroupsOutputArgs, opts ...InvokeOption) GetLocationGroupsResultOutput

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

    public static class GetLocationGroups 
{
    public static Task<GetLocationGroupsResult> InvokeAsync(GetLocationGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetLocationGroupsResult> Invoke(GetLocationGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLocationGroupsResult> getLocationGroups(GetLocationGroupsArgs args, InvokeOptions options)
public static Output<GetLocationGroupsResult> getLocationGroups(GetLocationGroupsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DynamicLocationGroupCriterias []GetLocationGroupsDynamicLocationGroupCriteria
    (Block Set) Dynamic location group information.
    Name string
    Location group name
    dynamicLocationGroupCriterias List<GetLocationGroupsDynamicLocationGroupCriteria>
    (Block Set) Dynamic location group information.
    name String
    Location group name
    dynamicLocationGroupCriterias GetLocationGroupsDynamicLocationGroupCriteria[]
    (Block Set) Dynamic location group information.
    name string
    Location group name
    dynamic_location_group_criterias Sequence[GetLocationGroupsDynamicLocationGroupCriteria]
    (Block Set) Dynamic location group information.
    name str
    Location group name
    dynamicLocationGroupCriterias List<Property Map>
    (Block Set) Dynamic location group information.
    name String
    Location group name

    getLocationGroups Result

    The following output properties are available:

    Comments string
    (List of Object)
    Deleted bool
    (Boolean) Indicates the location group was deleted
    GroupType string
    (String) The location group's type (i.e., Static or Dynamic)
    Id int
    (Number) Identifier that uniquely identifies an entity
    LastModTime int
    (List of Object) Automatically populated with the current time, after a successful POST or PUT request.
    LastModUsers List<zscaler.PulumiPackage.Zia.Outputs.GetLocationGroupsLastModUser>
    (List of Object)
    Locations List<zscaler.PulumiPackage.Zia.Outputs.GetLocationGroupsLocation>
    (List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
    Predefined bool
    (Boolean)
    DynamicLocationGroupCriterias List<zscaler.PulumiPackage.Zia.Outputs.GetLocationGroupsDynamicLocationGroupCriteria>
    (Block Set) Dynamic location group information.
    Name string
    (String) The configured name of the entity
    Comments string
    (List of Object)
    Deleted bool
    (Boolean) Indicates the location group was deleted
    GroupType string
    (String) The location group's type (i.e., Static or Dynamic)
    Id int
    (Number) Identifier that uniquely identifies an entity
    LastModTime int
    (List of Object) Automatically populated with the current time, after a successful POST or PUT request.
    LastModUsers []GetLocationGroupsLastModUser
    (List of Object)
    Locations []GetLocationGroupsLocation
    (List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
    Predefined bool
    (Boolean)
    DynamicLocationGroupCriterias []GetLocationGroupsDynamicLocationGroupCriteria
    (Block Set) Dynamic location group information.
    Name string
    (String) The configured name of the entity
    comments String
    (List of Object)
    deleted Boolean
    (Boolean) Indicates the location group was deleted
    groupType String
    (String) The location group's type (i.e., Static or Dynamic)
    id Integer
    (Number) Identifier that uniquely identifies an entity
    lastModTime Integer
    (List of Object) Automatically populated with the current time, after a successful POST or PUT request.
    lastModUsers List<GetLocationGroupsLastModUser>
    (List of Object)
    locations List<GetLocationGroupsLocation>
    (List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
    predefined Boolean
    (Boolean)
    dynamicLocationGroupCriterias List<GetLocationGroupsDynamicLocationGroupCriteria>
    (Block Set) Dynamic location group information.
    name String
    (String) The configured name of the entity
    comments string
    (List of Object)
    deleted boolean
    (Boolean) Indicates the location group was deleted
    groupType string
    (String) The location group's type (i.e., Static or Dynamic)
    id number
    (Number) Identifier that uniquely identifies an entity
    lastModTime number
    (List of Object) Automatically populated with the current time, after a successful POST or PUT request.
    lastModUsers GetLocationGroupsLastModUser[]
    (List of Object)
    locations GetLocationGroupsLocation[]
    (List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
    predefined boolean
    (Boolean)
    dynamicLocationGroupCriterias GetLocationGroupsDynamicLocationGroupCriteria[]
    (Block Set) Dynamic location group information.
    name string
    (String) The configured name of the entity
    comments str
    (List of Object)
    deleted bool
    (Boolean) Indicates the location group was deleted
    group_type str
    (String) The location group's type (i.e., Static or Dynamic)
    id int
    (Number) Identifier that uniquely identifies an entity
    last_mod_time int
    (List of Object) Automatically populated with the current time, after a successful POST or PUT request.
    last_mod_users Sequence[GetLocationGroupsLastModUser]
    (List of Object)
    locations Sequence[GetLocationGroupsLocation]
    (List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
    predefined bool
    (Boolean)
    dynamic_location_group_criterias Sequence[GetLocationGroupsDynamicLocationGroupCriteria]
    (Block Set) Dynamic location group information.
    name str
    (String) The configured name of the entity
    comments String
    (List of Object)
    deleted Boolean
    (Boolean) Indicates the location group was deleted
    groupType String
    (String) The location group's type (i.e., Static or Dynamic)
    id Number
    (Number) Identifier that uniquely identifies an entity
    lastModTime Number
    (List of Object) Automatically populated with the current time, after a successful POST or PUT request.
    lastModUsers List<Property Map>
    (List of Object)
    locations List<Property Map>
    (List of Object) The Name-ID pairs of the locations that are assigned to the static location group. This is ignored if the groupType is Dynamic.
    predefined Boolean
    (Boolean)
    dynamicLocationGroupCriterias List<Property Map>
    (Block Set) Dynamic location group information.
    name String
    (String) The configured name of the entity

    Supporting Types

    GetLocationGroupsDynamicLocationGroupCriteria

    EnableBandwidthControl bool
    (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
    EnableCaution bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    EnableXffForwarding bool
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    EnforceAup bool
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    EnforceAuthentication bool
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    EnforceFirewallControl bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    ManagedBies List<zscaler.PulumiPackage.Zia.Inputs.GetLocationGroupsDynamicLocationGroupCriteriaManagedBy>
    (Block List)
    Cities List<zscaler.PulumiPackage.Zia.Inputs.GetLocationGroupsDynamicLocationGroupCriteriaCity>
    (Block List)
    Countries List<string>
    (List of String) One or more countries from a predefined set
    Names List<zscaler.PulumiPackage.Zia.Inputs.GetLocationGroupsDynamicLocationGroupCriteriaName>
    Location group name
    Profiles List<string>
    (List of String) One or more location profiles from a predefined set
    EnableBandwidthControl bool
    (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
    EnableCaution bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    EnableXffForwarding bool
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    EnforceAup bool
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    EnforceAuthentication bool
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    EnforceFirewallControl bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    ManagedBies []GetLocationGroupsDynamicLocationGroupCriteriaManagedBy
    (Block List)
    Cities []GetLocationGroupsDynamicLocationGroupCriteriaCity
    (Block List)
    Countries []string
    (List of String) One or more countries from a predefined set
    Names []GetLocationGroupsDynamicLocationGroupCriteriaName
    Location group name
    Profiles []string
    (List of String) One or more location profiles from a predefined set
    enableBandwidthControl Boolean
    (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
    enableCaution Boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    enableXffForwarding Boolean
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    enforceAup Boolean
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    enforceAuthentication Boolean
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    enforceFirewallControl Boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    managedBies List<GetLocationGroupsDynamicLocationGroupCriteriaManagedBy>
    (Block List)
    cities List<GetLocationGroupsDynamicLocationGroupCriteriaCity>
    (Block List)
    countries List<String>
    (List of String) One or more countries from a predefined set
    names List<GetLocationGroupsDynamicLocationGroupCriteriaName>
    Location group name
    profiles List<String>
    (List of String) One or more location profiles from a predefined set
    enableBandwidthControl boolean
    (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
    enableCaution boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    enableXffForwarding boolean
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    enforceAup boolean
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    enforceAuthentication boolean
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    enforceFirewallControl boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    managedBies GetLocationGroupsDynamicLocationGroupCriteriaManagedBy[]
    (Block List)
    cities GetLocationGroupsDynamicLocationGroupCriteriaCity[]
    (Block List)
    countries string[]
    (List of String) One or more countries from a predefined set
    names GetLocationGroupsDynamicLocationGroupCriteriaName[]
    Location group name
    profiles string[]
    (List of String) One or more location profiles from a predefined set
    enable_bandwidth_control bool
    (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
    enable_caution bool
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    enable_xff_forwarding bool
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    enforce_aup bool
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    enforce_authentication bool
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    enforce_firewall_control bool
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    managed_bies Sequence[GetLocationGroupsDynamicLocationGroupCriteriaManagedBy]
    (Block List)
    cities Sequence[GetLocationGroupsDynamicLocationGroupCriteriaCity]
    (Block List)
    countries Sequence[str]
    (List of String) One or more countries from a predefined set
    names Sequence[GetLocationGroupsDynamicLocationGroupCriteriaName]
    Location group name
    profiles Sequence[str]
    (List of String) One or more location profiles from a predefined set
    enableBandwidthControl Boolean
    (Boolean) Enable Bandwidth Control. When set to true, Bandwidth Control is enabled for the location.
    enableCaution Boolean
    (Boolean) Enable Caution. When set to true, a caution notifcation is enabled for the location.
    enableXffForwarding Boolean
    (Boolean) Enable XFF Forwarding. When set to true, traffic is passed to Zscaler Cloud via the X-Forwarded-For (XFF) header.
    enforceAup Boolean
    (Boolean) Enable AUP. When set to true, AUP is enabled for the location.
    enforceAuthentication Boolean
    (Boolean) Enforce Authentication. Required when ports are enabled, IP Surrogate is enabled, or Kerberos Authentication is enabled.
    enforceFirewallControl Boolean
    (Boolean) Enable Firewall. When set to true, Firewall is enabled for the location.
    managedBies List<Property Map>
    (Block List)
    cities List<Property Map>
    (Block List)
    countries List<String>
    (List of String) One or more countries from a predefined set
    names List<Property Map>
    Location group name
    profiles List<String>
    (List of String) One or more location profiles from a predefined set

    GetLocationGroupsDynamicLocationGroupCriteriaCity

    MatchString string
    (String) String value to be matched or partially matched
    MatchType string
    (String) Operator that performs match action
    MatchString string
    (String) String value to be matched or partially matched
    MatchType string
    (String) Operator that performs match action
    matchString String
    (String) String value to be matched or partially matched
    matchType String
    (String) Operator that performs match action
    matchString string
    (String) String value to be matched or partially matched
    matchType string
    (String) Operator that performs match action
    match_string str
    (String) String value to be matched or partially matched
    match_type str
    (String) Operator that performs match action
    matchString String
    (String) String value to be matched or partially matched
    matchType String
    (String) Operator that performs match action

    GetLocationGroupsDynamicLocationGroupCriteriaManagedBy

    Extensions Dictionary<string, string>
    (Map of String)
    Id int
    Unique identifier for the location group
    Name string
    Location group name
    Extensions map[string]string
    (Map of String)
    Id int
    Unique identifier for the location group
    Name string
    Location group name
    extensions Map<String,String>
    (Map of String)
    id Integer
    Unique identifier for the location group
    name String
    Location group name
    extensions {[key: string]: string}
    (Map of String)
    id number
    Unique identifier for the location group
    name string
    Location group name
    extensions Mapping[str, str]
    (Map of String)
    id int
    Unique identifier for the location group
    name str
    Location group name
    extensions Map<String>
    (Map of String)
    id Number
    Unique identifier for the location group
    name String
    Location group name

    GetLocationGroupsDynamicLocationGroupCriteriaName

    MatchString string
    (String) String value to be matched or partially matched
    MatchType string
    (String) Operator that performs match action
    MatchString string
    (String) String value to be matched or partially matched
    MatchType string
    (String) Operator that performs match action
    matchString String
    (String) String value to be matched or partially matched
    matchType String
    (String) Operator that performs match action
    matchString string
    (String) String value to be matched or partially matched
    matchType string
    (String) Operator that performs match action
    match_string str
    (String) String value to be matched or partially matched
    match_type str
    (String) Operator that performs match action
    matchString String
    (String) String value to be matched or partially matched
    matchType String
    (String) Operator that performs match action

    GetLocationGroupsLastModUser

    Extensions Dictionary<string, string>
    (Map of String)
    Id int
    Unique identifier for the location group
    Name string
    Location group name
    Extensions map[string]string
    (Map of String)
    Id int
    Unique identifier for the location group
    Name string
    Location group name
    extensions Map<String,String>
    (Map of String)
    id Integer
    Unique identifier for the location group
    name String
    Location group name
    extensions {[key: string]: string}
    (Map of String)
    id number
    Unique identifier for the location group
    name string
    Location group name
    extensions Mapping[str, str]
    (Map of String)
    id int
    Unique identifier for the location group
    name str
    Location group name
    extensions Map<String>
    (Map of String)
    id Number
    Unique identifier for the location group
    name String
    Location group name

    GetLocationGroupsLocation

    Extensions Dictionary<string, string>
    (Map of String)
    Id int
    Unique identifier for the location group
    Name string
    Location group name
    Extensions map[string]string
    (Map of String)
    Id int
    Unique identifier for the location group
    Name string
    Location group name
    extensions Map<String,String>
    (Map of String)
    id Integer
    Unique identifier for the location group
    name String
    Location group name
    extensions {[key: string]: string}
    (Map of String)
    id number
    Unique identifier for the location group
    name string
    Location group name
    extensions Mapping[str, str]
    (Map of String)
    id int
    Unique identifier for the location group
    name str
    Location group name
    extensions Map<String>
    (Map of String)
    id Number
    Unique identifier for the location group
    name String
    Location group name

    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.0.1 published on Friday, Jun 6, 2025 by Zscaler
    zscaler/pulumi-zia