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

    The zia.WorkloadGroup resource manages workload groups in the Zscaler Internet Access (ZIA) cloud. Workload groups define sets of cloud workloads based on tag expressions that can be used in firewall rules, URL filtering rules, and other policy rules to apply policies to specific cloud workloads (e.g., VMs, subnets, ENIs).

    Example Usage

    Basic Workload Group

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";
    
    const example = new zia.WorkloadGroup("example", {
        name: "Example Workload Group",
        description: "Managed by Pulumi",
        expressionJson: {
            expressionContainers: [{
                tagType: "VM",
                operator: "AND",
                tagContainer: {
                    tags: [{
                        key: "environment",
                        value: "production",
                    }],
                    operator: "OR",
                },
            }],
        },
    });
    
    import zscaler_pulumi_zia as zia
    
    example = zia.WorkloadGroup("example",
        name="Example Workload Group",
        description="Managed by Pulumi",
        expression_json={
            "expression_containers": [{
                "tag_type": "VM",
                "operator": "AND",
                "tag_container": {
                    "tags": [{
                        "key": "environment",
                        "value": "production",
                    }],
                    "operator": "OR",
                },
            }],
        },
    )
    
    resources:
      example:
        type: zia:WorkloadGroup
        properties:
          name: Example Workload Group
          description: Managed by Pulumi
          expressionJson:
            expressionContainers:
              - tagType: VM
                operator: AND
                tagContainer:
                  tags:
                    - key: environment
                      value: production
                  operator: OR
    

    Create WorkloadGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkloadGroup(name: string, args?: WorkloadGroupArgs, opts?: CustomResourceOptions);
    @overload
    def WorkloadGroup(resource_name: str,
                      args: Optional[WorkloadGroupArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkloadGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      expression_json: Optional[WorkloadGroupExpressionJsonInputArgs] = None,
                      name: Optional[str] = None)
    func NewWorkloadGroup(ctx *Context, name string, args *WorkloadGroupArgs, opts ...ResourceOption) (*WorkloadGroup, error)
    public WorkloadGroup(string name, WorkloadGroupArgs? args = null, CustomResourceOptions? opts = null)
    public WorkloadGroup(String name, WorkloadGroupArgs args)
    public WorkloadGroup(String name, WorkloadGroupArgs args, CustomResourceOptions options)
    
    type: zia:WorkloadGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WorkloadGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkloadGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkloadGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workloadGroupResource = new Zia.WorkloadGroup("workloadGroupResource", new()
    {
        Description = "string",
        ExpressionJson = new Zia.Inputs.WorkloadGroupExpressionJsonInputArgs
        {
            ExpressionContainers = new[]
            {
                new Zia.Inputs.WorkloadGroupExpressionContainerInputArgs
                {
                    Operator = "string",
                    TagContainer = new Zia.Inputs.WorkloadGroupTagContainerInputArgs
                    {
                        Operator = "string",
                        Tags = new[]
                        {
                            new Zia.Inputs.WorkloadGroupTagInputArgs
                            {
                                Key = "string",
                                Value = "string",
                            },
                        },
                    },
                    TagType = "string",
                },
            },
        },
        Name = "string",
    });
    
    example, err := zia.NewWorkloadGroup(ctx, "workloadGroupResource", &zia.WorkloadGroupArgs{
    	Description: pulumi.String("string"),
    	ExpressionJson: &pulumizia.WorkloadGroupExpressionJsonInputArgs{
    		ExpressionContainers: pulumizia.WorkloadGroupExpressionContainerInputArray{
    			&pulumizia.WorkloadGroupExpressionContainerInputArgs{
    				Operator: pulumi.String("string"),
    				TagContainer: &pulumizia.WorkloadGroupTagContainerInputArgs{
    					Operator: pulumi.String("string"),
    					Tags: pulumizia.WorkloadGroupTagInputArray{
    						&pulumizia.WorkloadGroupTagInputArgs{
    							Key:   pulumi.String("string"),
    							Value: pulumi.String("string"),
    						},
    					},
    				},
    				TagType: pulumi.String("string"),
    			},
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var workloadGroupResource = new WorkloadGroup("workloadGroupResource", WorkloadGroupArgs.builder()
        .description("string")
        .expressionJson(WorkloadGroupExpressionJsonInputArgs.builder()
            .expressionContainers(WorkloadGroupExpressionContainerInputArgs.builder()
                .operator("string")
                .tagContainer(WorkloadGroupTagContainerInputArgs.builder()
                    .operator("string")
                    .tags(WorkloadGroupTagInputArgs.builder()
                        .key("string")
                        .value("string")
                        .build())
                    .build())
                .tagType("string")
                .build())
            .build())
        .name("string")
        .build());
    
    workload_group_resource = zia.WorkloadGroup("workloadGroupResource",
        description="string",
        expression_json={
            "expression_containers": [{
                "operator": "string",
                "tag_container": {
                    "operator": "string",
                    "tags": [{
                        "key": "string",
                        "value": "string",
                    }],
                },
                "tag_type": "string",
            }],
        },
        name="string")
    
    const workloadGroupResource = new zia.WorkloadGroup("workloadGroupResource", {
        description: "string",
        expressionJson: {
            expressionContainers: [{
                operator: "string",
                tagContainer: {
                    operator: "string",
                    tags: [{
                        key: "string",
                        value: "string",
                    }],
                },
                tagType: "string",
            }],
        },
        name: "string",
    });
    
    type: zia:WorkloadGroup
    properties:
        description: string
        expressionJson:
            expressionContainers:
                - operator: string
                  tagContainer:
                    operator: string
                    tags:
                        - key: string
                          value: string
                  tagType: string
        name: string
    

    WorkloadGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkloadGroup resource accepts the following input properties:

    Description string
    Description of the workload group.
    ExpressionJson zscaler.PulumiPackage.Zia.Inputs.WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria using tag expressions.
    Name string
    Name of the workload group.
    Description string
    Description of the workload group.
    ExpressionJson WorkloadGroupExpressionJsonInputArgs
    The expression JSON that defines the workload group matching criteria using tag expressions.
    Name string
    Name of the workload group.
    description String
    Description of the workload group.
    expressionJson WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria using tag expressions.
    name String
    Name of the workload group.
    description string
    Description of the workload group.
    expressionJson WorkloadGroupExpressionJsonInput
    The expression JSON that defines the workload group matching criteria using tag expressions.
    name string
    Name of the workload group.
    description str
    Description of the workload group.
    expression_json WorkloadGroupExpressionJsonInputArgs
    The expression JSON that defines the workload group matching criteria using tag expressions.
    name str
    Name of the workload group.
    description String
    Description of the workload group.
    expressionJson Property Map
    The expression JSON that defines the workload group matching criteria using tag expressions.
    name String
    Name of the workload group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkloadGroup resource produces the following output properties:

    GroupId int
    The unique identifier for the workload group assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    GroupId int
    The unique identifier for the workload group assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    groupId Integer
    The unique identifier for the workload group assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    groupId number
    The unique identifier for the workload group assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    group_id int
    The unique identifier for the workload group assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    groupId Number
    The unique identifier for the workload group assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    WorkloadGroupExpressionContainerInput, WorkloadGroupExpressionContainerInputArgs

    WorkloadGroupExpressionJsonInput, WorkloadGroupExpressionJsonInputArgs

    WorkloadGroupTagContainerInput, WorkloadGroupTagContainerInputArgs

    WorkloadGroupTagInput, WorkloadGroupTagInputArgs

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

    Import

    An existing workload group can be imported using its ID, e.g.

    $ pulumi import zia:index:WorkloadGroup example 12345
    

    To learn more about importing existing cloud resources, see Importing resources.

    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
      Try Pulumi Cloud free. Your team will thank you.