1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getWorkloadGroup
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.getWorkloadGroup

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    Use this data source to look up a workload group by ID or name.

    Using getWorkloadGroup

    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 getWorkloadGroup(args: GetWorkloadGroupArgs, opts?: InvokeOptions): Promise<GetWorkloadGroupResult>
function getWorkloadGroupOutput(args: GetWorkloadGroupOutputArgs, opts?: InvokeOptions): Output<GetWorkloadGroupResult>
    def get_workload_group(group_id: Optional[int] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetWorkloadGroupResult
def get_workload_group_output(group_id: Optional[pulumi.Input[int]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetWorkloadGroupResult]
    func LookupWorkloadGroup(ctx *Context, args *LookupWorkloadGroupArgs, opts ...InvokeOption) (*LookupWorkloadGroupResult, error)
func LookupWorkloadGroupOutput(ctx *Context, args *LookupWorkloadGroupOutputArgs, opts ...InvokeOption) LookupWorkloadGroupResultOutput

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

    public static class GetWorkloadGroup 
{
    public static Task<GetWorkloadGroupResult> InvokeAsync(GetWorkloadGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkloadGroupResult> Invoke(GetWorkloadGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkloadGroupResult> getWorkloadGroup(GetWorkloadGroupArgs args, InvokeOptions options)
public static Output<GetWorkloadGroupResult> getWorkloadGroup(GetWorkloadGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: zia:getWorkloadGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GroupId int
    The ID of the workload group to look up.
    Name string
    The name of the workload group to look up.
    GroupId int
    The ID of the workload group to look up.
    Name string
    The name of the workload group to look up.
    groupId Integer
    The ID of the workload group to look up.
    name String
    The name of the workload group to look up.
    groupId number
    The ID of the workload group to look up.
    name string
    The name of the workload group to look up.
    group_id int
    The ID of the workload group to look up.
    name str
    The name of the workload group to look up.
    groupId Number
    The ID of the workload group to look up.
    name String
    The name of the workload group to look up.

    getWorkloadGroup Result

    The following output properties are available:

    Description string
    The description of the workload group.
    Expression string
    The expression string for the workload group.
    GroupId int
    The ID of the workload group.
    LastModifiedTime int
    The last modification time of the workload group (epoch).
    Name string
    The name of the workload group.
    ExpressionJson zscaler.PulumiPackage.Zia.Outputs.WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria.
    Description string
    The description of the workload group.
    Expression string
    The expression string for the workload group.
    GroupId int
    The ID of the workload group.
    LastModifiedTime int
    The last modification time of the workload group (epoch).
    Name string
    The name of the workload group.
    ExpressionJson WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria.
    description String
    The description of the workload group.
    expression String
    The expression string for the workload group.
    groupId Integer
    The ID of the workload group.
    lastModifiedTime Integer
    The last modification time of the workload group (epoch).
    name String
    The name of the workload group.
    expressionJson WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria.
    description string
    The description of the workload group.
    expression string
    The expression string for the workload group.
    groupId number
    The ID of the workload group.
    lastModifiedTime number
    The last modification time of the workload group (epoch).
    name string
    The name of the workload group.
    expressionJson WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria.
    description str
    The description of the workload group.
    expression str
    The expression string for the workload group.
    group_id int
    The ID of the workload group.
    last_modified_time int
    The last modification time of the workload group (epoch).
    name str
    The name of the workload group.
    expression_json WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria.
    description String
    The description of the workload group.
    expression String
    The expression string for the workload group.
    groupId Number
    The ID of the workload group.
    lastModifiedTime Number
    The last modification time of the workload group (epoch).
    name String
    The name of the workload group.
    expressionJson Property Map
    The expression JSON that defines the workload group matching criteria.

    Supporting Types

    WorkloadGroupExpressionContainerInput

    WorkloadGroupExpressionJsonInput

    WorkloadGroupTagContainerInput

    WorkloadGroupTagInput

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.