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

zia.getWorkloadGroups

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_workload_groups data source to get information about Workload Groups in the Zscaler Internet Access cloud or via the API. This data source can then be used as a criterion in ZIA policies such as, Firewall Filtering, URL Filtering, and Data Loss Prevention (DLP) to apply security policies to the workload traffic.

    Example Usage

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

const ios = zia.getWorkloadGroups({
    name: "Example",
});

    import pulumi
import pulumi_zia as zia

ios = zia.get_workload_groups(name="Example")

    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.GetWorkloadGroups(ctx, &zia.GetWorkloadGroupsArgs{
			Name: pulumi.StringRef("Example"),
		}, 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 ios = Zia.GetWorkloadGroups.Invoke(new()
    {
        Name = "Example",
    });

});

    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.GetWorkloadGroupsArgs;
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 ios = ZiaFunctions.getWorkloadGroups(GetWorkloadGroupsArgs.builder()
            .name("Example")
            .build());

    }
}

    variables:
  ios:
    fn::invoke:
      Function: zia:getWorkloadGroups
      Arguments:
        name: Example

    Using getWorkloadGroups

    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 getWorkloadGroups(args: GetWorkloadGroupsArgs, opts?: InvokeOptions): Promise<GetWorkloadGroupsResult>
function getWorkloadGroupsOutput(args: GetWorkloadGroupsOutputArgs, opts?: InvokeOptions): Output<GetWorkloadGroupsResult>
    def get_workload_groups(name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetWorkloadGroupsResult
def get_workload_groups_output(name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetWorkloadGroupsResult]
    func GetWorkloadGroups(ctx *Context, args *GetWorkloadGroupsArgs, opts ...InvokeOption) (*GetWorkloadGroupsResult, error)
func GetWorkloadGroupsOutput(ctx *Context, args *GetWorkloadGroupsOutputArgs, opts ...InvokeOption) GetWorkloadGroupsResultOutput

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

    public static class GetWorkloadGroups 
{
    public static Task<GetWorkloadGroupsResult> InvokeAsync(GetWorkloadGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkloadGroupsResult> Invoke(GetWorkloadGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkloadGroupsResult> getWorkloadGroups(GetWorkloadGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Name string
    The name of the workload group to be exported.
    Name string
    The name of the workload group to be exported.
    name String
    The name of the workload group to be exported.
    name string
    The name of the workload group to be exported.
    name str
    The name of the workload group to be exported.
    name String
    The name of the workload group to be exported.

    getWorkloadGroups Result

    The following output properties are available:

    Description string
    (String) The description of the workload group.
    Expression string
    (String) The workload group expression containing tag types, tags, and their relationships.
    ExpressionJsons List<zscaler.PulumiPackage.Zia.Outputs.GetWorkloadGroupsExpressionJson>
    (List) The workload group expression containing tag types, tags, and their relationships represented in a JSON format.
    Id int
    (Number) Identifier that uniquely identifies an entity
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetWorkloadGroupsLastModifiedBy>
    LastModifiedTime int
    (Number) When the rule was last modified
    Name string
    (String) The configured name of the entity
    Description string
    (String) The description of the workload group.
    Expression string
    (String) The workload group expression containing tag types, tags, and their relationships.
    ExpressionJsons []GetWorkloadGroupsExpressionJson
    (List) The workload group expression containing tag types, tags, and their relationships represented in a JSON format.
    Id int
    (Number) Identifier that uniquely identifies an entity
    LastModifiedBies []GetWorkloadGroupsLastModifiedBy
    LastModifiedTime int
    (Number) When the rule was last modified
    Name string
    (String) The configured name of the entity
    description String
    (String) The description of the workload group.
    expression String
    (String) The workload group expression containing tag types, tags, and their relationships.
    expressionJsons List<GetWorkloadGroupsExpressionJson>
    (List) The workload group expression containing tag types, tags, and their relationships represented in a JSON format.
    id Integer
    (Number) Identifier that uniquely identifies an entity
    lastModifiedBies List<GetWorkloadGroupsLastModifiedBy>
    lastModifiedTime Integer
    (Number) When the rule was last modified
    name String
    (String) The configured name of the entity
    description string
    (String) The description of the workload group.
    expression string
    (String) The workload group expression containing tag types, tags, and their relationships.
    expressionJsons GetWorkloadGroupsExpressionJson[]
    (List) The workload group expression containing tag types, tags, and their relationships represented in a JSON format.
    id number
    (Number) Identifier that uniquely identifies an entity
    lastModifiedBies GetWorkloadGroupsLastModifiedBy[]
    lastModifiedTime number
    (Number) When the rule was last modified
    name string
    (String) The configured name of the entity
    description str
    (String) The description of the workload group.
    expression str
    (String) The workload group expression containing tag types, tags, and their relationships.
    expression_jsons Sequence[GetWorkloadGroupsExpressionJson]
    (List) The workload group expression containing tag types, tags, and their relationships represented in a JSON format.
    id int
    (Number) Identifier that uniquely identifies an entity
    last_modified_bies Sequence[GetWorkloadGroupsLastModifiedBy]
    last_modified_time int
    (Number) When the rule was last modified
    name str
    (String) The configured name of the entity
    description String
    (String) The description of the workload group.
    expression String
    (String) The workload group expression containing tag types, tags, and their relationships.
    expressionJsons List<Property Map>
    (List) The workload group expression containing tag types, tags, and their relationships represented in a JSON format.
    id Number
    (Number) Identifier that uniquely identifies an entity
    lastModifiedBies List<Property Map>
    lastModifiedTime Number
    (Number) When the rule was last modified
    name String
    (String) The configured name of the entity

    Supporting Types

    GetWorkloadGroupsExpressionJson

    ExpressionContainers List<zscaler.PulumiPackage.Zia.Inputs.GetWorkloadGroupsExpressionJsonExpressionContainer>
    (List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
    ExpressionContainers []GetWorkloadGroupsExpressionJsonExpressionContainer
    (List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
    expressionContainers List<GetWorkloadGroupsExpressionJsonExpressionContainer>
    (List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
    expressionContainers GetWorkloadGroupsExpressionJsonExpressionContainer[]
    (List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
    expression_containers Sequence[GetWorkloadGroupsExpressionJsonExpressionContainer]
    (List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
    expressionContainers List<Property Map>
    (List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group

    GetWorkloadGroupsExpressionJsonExpressionContainer

    Operator string
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    TagContainers List<zscaler.PulumiPackage.Zia.Inputs.GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer>
    (String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
    TagType string
    (String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
    Operator string
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    TagContainers []GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer
    (String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
    TagType string
    (String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
    operator String
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tagContainers List<GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer>
    (String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
    tagType String
    (String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
    operator string
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tagContainers GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer[]
    (String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
    tagType string
    (String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
    operator str
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tag_containers Sequence[GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer]
    (String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
    tag_type str
    (String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
    operator String
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tagContainers List<Property Map>
    (String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
    tagType String
    (String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR

    GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer

    Operator string
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    Tags List<zscaler.PulumiPackage.Zia.Inputs.GetWorkloadGroupsExpressionJsonExpressionContainerTagContainerTag>
    (String) One or more tags, each consisting of a key-value pair, selected within a tag type. If multiple tags are present within a tag type, they are combined using a logical operator. Note: A maximum of 8 tags can be added to a workload group, irrespective of the number of tag types present.
    Operator string
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    Tags []GetWorkloadGroupsExpressionJsonExpressionContainerTagContainerTag
    (String) One or more tags, each consisting of a key-value pair, selected within a tag type. If multiple tags are present within a tag type, they are combined using a logical operator. Note: A maximum of 8 tags can be added to a workload group, irrespective of the number of tag types present.
    operator String
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tags List<GetWorkloadGroupsExpressionJsonExpressionContainerTagContainerTag>
    (String) One or more tags, each consisting of a key-value pair, selected within a tag type. If multiple tags are present within a tag type, they are combined using a logical operator. Note: A maximum of 8 tags can be added to a workload group, irrespective of the number of tag types present.
    operator string
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tags GetWorkloadGroupsExpressionJsonExpressionContainerTagContainerTag[]
    (String) One or more tags, each consisting of a key-value pair, selected within a tag type. If multiple tags are present within a tag type, they are combined using a logical operator. Note: A maximum of 8 tags can be added to a workload group, irrespective of the number of tag types present.
    operator str
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tags Sequence[GetWorkloadGroupsExpressionJsonExpressionContainerTagContainerTag]
    (String) One or more tags, each consisting of a key-value pair, selected within a tag type. If multiple tags are present within a tag type, they are combined using a logical operator. Note: A maximum of 8 tags can be added to a workload group, irrespective of the number of tag types present.
    operator String
    (String) The operator (either AND or OR) used to create logical relationships among tag types. Returned values are: AND, OR, OPEN_PARENTHESES, CLOSE_PARENTHESES
    tags List<Property Map>
    (String) One or more tags, each consisting of a key-value pair, selected within a tag type. If multiple tags are present within a tag type, they are combined using a logical operator. Note: A maximum of 8 tags can be added to a workload group, irrespective of the number of tag types present.

    GetWorkloadGroupsExpressionJsonExpressionContainerTagContainerTag

    Key string
    (String) The key component present in the key-value pair contained in a tag
    Value string
    (string) The value component present in the key-value pair contained in a tag
    Key string
    (String) The key component present in the key-value pair contained in a tag
    Value string
    (string) The value component present in the key-value pair contained in a tag
    key String
    (String) The key component present in the key-value pair contained in a tag
    value String
    (string) The value component present in the key-value pair contained in a tag
    key string
    (String) The key component present in the key-value pair contained in a tag
    value string
    (string) The value component present in the key-value pair contained in a tag
    key str
    (String) The key component present in the key-value pair contained in a tag
    value str
    (string) The value component present in the key-value pair contained in a tag
    key String
    (String) The key component present in the key-value pair contained in a tag
    value String
    (string) The value component present in the key-value pair contained in a tag

    GetWorkloadGroupsLastModifiedBy

    Extensions Dictionary<string, string>
    (Map of String)
    ExternalId string
    Id int
    The unique identifer for the workload group.
    Name string
    The name of the workload group to be exported.
    Extensions map[string]string
    (Map of String)
    ExternalId string
    Id int
    The unique identifer for the workload group.
    Name string
    The name of the workload group to be exported.
    extensions Map<String,String>
    (Map of String)
    externalId String
    id Integer
    The unique identifer for the workload group.
    name String
    The name of the workload group to be exported.
    extensions {[key: string]: string}
    (Map of String)
    externalId string
    id number
    The unique identifer for the workload group.
    name string
    The name of the workload group to be exported.
    extensions Mapping[str, str]
    (Map of String)
    external_id str
    id int
    The unique identifer for the workload group.
    name str
    The name of the workload group to be exported.
    extensions Map<String>
    (Map of String)
    externalId String
    id Number
    The unique identifer for the workload group.
    name String
    The name of the workload group 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.6 published on Wednesday, Apr 10, 2024 by Zscaler
    zscaler/pulumi-zia