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

zia.getWorkloadGroups

Explore with Pulumi AI

Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 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",
});
Copy
import pulumi
import pulumi_zia as zia

ios = zia.get_workload_groups(name="Example")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func GetWorkloadGroups(ctx *Context, args *GetWorkloadGroupsArgs, opts ...InvokeOption) (*GetWorkloadGroupsResult, error)
func GetWorkloadGroupsOutput(ctx *Context, args *GetWorkloadGroupsOutputArgs, opts ...InvokeOption) GetWorkloadGroupsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetWorkloadGroupsResult> getWorkloadGroups(GetWorkloadGroupsArgs args, InvokeOptions options)
public static Output<GetWorkloadGroupsResult> getWorkloadGroups(GetWorkloadGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: zia:index/getWorkloadGroups:getWorkloadGroups
  arguments:
    # arguments dictionary
Copy

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 This property is required. 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 This property is required. []GetWorkloadGroupsExpressionJsonExpressionContainer
(List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
expressionContainers This property is required. List<GetWorkloadGroupsExpressionJsonExpressionContainer>
(List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
expressionContainers This property is required. GetWorkloadGroupsExpressionJsonExpressionContainer[]
(List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
expression_containers This property is required. Sequence[GetWorkloadGroupsExpressionJsonExpressionContainer]
(List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group
expressionContainers This property is required. List<Property Map>
(List) Contains one or more tag types (and associated tags) combined using logical operators within a workload group

GetWorkloadGroupsExpressionJsonExpressionContainer

Operator This property is required. 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 This property is required. 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 This property is required. string
(String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
Operator This property is required. 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 This property is required. []GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer
(String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
TagType This property is required. string
(String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
operator This property is required. 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 This property is required. List<GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer>
(String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
tagType This property is required. String
(String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
operator This property is required. 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 This property is required. GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer[]
(String) Contains one or more tags and the logical operator used to combine the tags within a tag type CLOSE_PARENTHESES
tagType This property is required. string
(String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
operator This property is required. 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 This property is required. 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 This property is required. str
(String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR
operator This property is required. 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 This property is required. 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 This property is required. String
(String) The tag type selected from a predefined list. Returned values are: ANY, VPC, SUBNET, VM, ENI, ATTR

GetWorkloadGroupsExpressionJsonExpressionContainerTagContainer

Operator This property is required. 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 This property is required. 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 This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
(String) The key component present in the key-value pair contained in a tag
Value This property is required. string
(string) The value component present in the key-value pair contained in a tag
Key This property is required. string
(String) The key component present in the key-value pair contained in a tag
Value This property is required. string
(string) The value component present in the key-value pair contained in a tag
key This property is required. String
(String) The key component present in the key-value pair contained in a tag
value This property is required. String
(string) The value component present in the key-value pair contained in a tag
key This property is required. string
(String) The key component present in the key-value pair contained in a tag
value This property is required. string
(string) The value component present in the key-value pair contained in a tag
key This property is required. str
(String) The key component present in the key-value pair contained in a tag
value This property is required. str
(string) The value component present in the key-value pair contained in a tag
key This property is required. String
(String) The key component present in the key-value pair contained in a tag
value This property is required. String
(string) The value component present in the key-value pair contained in a tag

GetWorkloadGroupsLastModifiedBy

Extensions This property is required. Dictionary<string, string>
(Map of String)
ExternalId This property is required. string
Id This property is required. int
The unique identifer for the workload group.
Name This property is required. string
The name of the workload group to be exported.
Extensions This property is required. map[string]string
(Map of String)
ExternalId This property is required. string
Id This property is required. int
The unique identifer for the workload group.
Name This property is required. string
The name of the workload group to be exported.
extensions This property is required. Map<String,String>
(Map of String)
externalId This property is required. String
id This property is required. Integer
The unique identifer for the workload group.
name This property is required. String
The name of the workload group to be exported.
extensions This property is required. {[key: string]: string}
(Map of String)
externalId This property is required. string
id This property is required. number
The unique identifer for the workload group.
name This property is required. string
The name of the workload group to be exported.
extensions This property is required. Mapping[str, str]
(Map of String)
external_id This property is required. str
id This property is required. int
The unique identifer for the workload group.
name This property is required. str
The name of the workload group to be exported.
extensions This property is required. Map<String>
(Map of String)
externalId This property is required. String
id This property is required. Number
The unique identifer for the workload group.
name This property is required. 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.
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia