getTagGroup

Zscaler Private Access v1.0.4, Jun 29 26

Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler

Schema (JSON)

zscaler/pulumi-zpa

Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler

Schema (JSON)

zscaler/pulumi-zpa

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as zpa from "@bdzscaler/pulumi-zpa";

const _this = zpa.getTagGroup({
    name: "Example Tag Group",
});
export const zpaTagGroup = _this;

import pulumi
import pulumi_zpa as zpa

this = zpa.get_tag_group(name="Example Tag Group")
pulumi.export("zpaTagGroup", this)

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := zpa.GetTagGroup(ctx, &zpa.LookupTagGroupArgs{
			Name: pulumi.StringRef("Example Tag Group"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("zpaTagGroup", this)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = zscaler.PulumiPackage.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = Zpa.GetTagGroup.Invoke(new()
    {
        Name = "Example Tag Group",
    });

    return new Dictionary<string, object?>
    {
        ["zpaTagGroup"] = @this,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ZpaFunctions;
import com.pulumi.zpa.inputs.GetTagGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 this = ZpaFunctions.getTagGroup(GetTagGroupArgs.builder()
            .name("Example Tag Group")
            .build());

        ctx.export("zpaTagGroup", this_);
    }
}

variables:
  this:
    fn::invoke:
      function: zpa:getTagGroup
      arguments:
        name: Example Tag Group
outputs:
  zpaTagGroup: ${this}

pulumi {
  required_providers {
    zpa = {
      source = "pulumi/zpa"
    }
  }
}

data "zpa_gettaggroup" "this" {
  name = "Example Tag Group"
}

output "zpaTagGroup" {
  value = data.zpa_gettaggroup.this
}

import * as pulumi from "@pulumi/pulumi";
import * as zpa from "@bdzscaler/pulumi-zpa";

const _this = zpa.getTagGroup({
    id: "123456789",
});

import pulumi
import pulumi_zpa as zpa

this = zpa.get_tag_group(id="123456789")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zpa.GetTagGroup(ctx, &zpa.LookupTagGroupArgs{
			Id: pulumi.StringRef("123456789"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = zscaler.PulumiPackage.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = Zpa.GetTagGroup.Invoke(new()
    {
        Id = "123456789",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ZpaFunctions;
import com.pulumi.zpa.inputs.GetTagGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 this = ZpaFunctions.getTagGroup(GetTagGroupArgs.builder()
            .id("123456789")
            .build());

    }
}

variables:
  this:
    fn::invoke:
      function: zpa:getTagGroup
      arguments:
        id: '123456789'

pulumi {
  required_providers {
    zpa = {
      source = "pulumi/zpa"
    }
  }
}

data "zpa_gettaggroup" "this" {
  id = "123456789"
}

Using getTagGroup

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 getTagGroup(args: GetTagGroupArgs, opts?: InvokeOptions): Promise<GetTagGroupResult>
function getTagGroupOutput(args: GetTagGroupOutputArgs, opts?: InvokeOptions): Output<GetTagGroupResult>

def get_tag_group(id: Optional[str] = None,
                  microtenant_id: Optional[str] = None,
                  name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetTagGroupResult
def get_tag_group_output(id: pulumi.Input[Optional[str]] = None,
                  microtenant_id: pulumi.Input[Optional[str]] = None,
                  name: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetTagGroupResult]

func LookupTagGroup(ctx *Context, args *LookupTagGroupArgs, opts ...InvokeOption) (*LookupTagGroupResult, error)
func LookupTagGroupOutput(ctx *Context, args *LookupTagGroupOutputArgs, opts ...InvokeOption) LookupTagGroupResultOutput

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

public static class GetTagGroup 
{
    public static Task<GetTagGroupResult> InvokeAsync(GetTagGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetTagGroupResult> Invoke(GetTagGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTagGroupResult> getTagGroup(GetTagGroupArgs args, InvokeOptions options)
public static Output<GetTagGroupResult> getTagGroup(GetTagGroupArgs args, InvokeOptions options)

fn::invoke:
  function: zpa:index/getTagGroup:getTagGroup
  arguments:
    # arguments dictionary

data "zpa_get_tag_group" "name" {
    # arguments
}

The following arguments are supported:

Id string: The ID of the tag group.
MicrotenantId string: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
Name string: The name of the tag group.

Id string: The ID of the tag group.
MicrotenantId string: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
Name string: The name of the tag group.

id string: The ID of the tag group.
microtenant_id string: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
name string: The name of the tag group.

id String: The ID of the tag group.
microtenantId String: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
name String: The name of the tag group.

id string: The ID of the tag group.
microtenantId string: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
name string: The name of the tag group.

id str: The ID of the tag group.
microtenant_id str: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
name str: The name of the tag group.

id String: The ID of the tag group.
microtenantId String: The ID of the microtenant.
NOTE: id and name are mutually exclusive but at least one must be provided.
name String: The name of the tag group.

getTagGroup Result

The following output properties are available:

Description string: The description of the tag group.
MicrotenantName string: The name of the microtenant.
Tags List<zscaler.PulumiPackage.Zpa.Outputs.GetTagGroupTag>: A list of tags in this tag group. Each element contains:
Id string: The ID of the tag value.
MicrotenantId string: The ID of the microtenant.
Name string: The name of the tag value.

Description string: The description of the tag group.
MicrotenantName string: The name of the microtenant.
Tags []GetTagGroupTag: A list of tags in this tag group. Each element contains:
Id string: The ID of the tag value.
MicrotenantId string: The ID of the microtenant.
Name string: The name of the tag value.

description string: The description of the tag group.
microtenant_name string: The name of the microtenant.
tags list(object): A list of tags in this tag group. Each element contains:
id string: The ID of the tag value.
microtenant_id string: The ID of the microtenant.
name string: The name of the tag value.

description String: The description of the tag group.
microtenantName String: The name of the microtenant.
tags List<GetTagGroupTag>: A list of tags in this tag group. Each element contains:
id String: The ID of the tag value.
microtenantId String: The ID of the microtenant.
name String: The name of the tag value.

description string: The description of the tag group.
microtenantName string: The name of the microtenant.
tags GetTagGroupTag[]: A list of tags in this tag group. Each element contains:
id string: The ID of the tag value.
microtenantId string: The ID of the microtenant.
name string: The name of the tag value.

description str: The description of the tag group.
microtenant_name str: The name of the microtenant.
tags Sequence[GetTagGroupTag]: A list of tags in this tag group. Each element contains:
id str: The ID of the tag value.
microtenant_id str: The ID of the microtenant.
name str: The name of the tag value.

description String: The description of the tag group.
microtenantName String: The name of the microtenant.
tags List<Property Map>: A list of tags in this tag group. Each element contains:
id String: The ID of the tag value.
microtenantId String: The ID of the microtenant.
name String: The name of the tag value.

Supporting Types

GetTagGroupTag

Namespaces List<zscaler.PulumiPackage.Zpa.Inputs.GetTagGroupTagNamespace>: A list containing the tag namespace details:
Origin string: The origin of the tag.
TagKeys List<zscaler.PulumiPackage.Zpa.Inputs.GetTagGroupTagTagKey>: A list containing the tag key details:
TagValues List<zscaler.PulumiPackage.Zpa.Inputs.GetTagGroupTagTagValue>: A list containing the tag value details:

Namespaces []GetTagGroupTagNamespace: A list containing the tag namespace details:
Origin string: The origin of the tag.
TagKeys []GetTagGroupTagTagKey: A list containing the tag key details:
TagValues []GetTagGroupTagTagValue: A list containing the tag value details:

namespaces list(object): A list containing the tag namespace details:
origin string: The origin of the tag.
tag_keys list(object): A list containing the tag key details:
tag_values list(object): A list containing the tag value details:

namespaces List<GetTagGroupTagNamespace>: A list containing the tag namespace details:
origin String: The origin of the tag.
tagKeys List<GetTagGroupTagTagKey>: A list containing the tag key details:
tagValues List<GetTagGroupTagTagValue>: A list containing the tag value details:

namespaces GetTagGroupTagNamespace[]: A list containing the tag namespace details:
origin string: The origin of the tag.
tagKeys GetTagGroupTagTagKey[]: A list containing the tag key details:
tagValues GetTagGroupTagTagValue[]: A list containing the tag value details:

namespaces Sequence[GetTagGroupTagNamespace]: A list containing the tag namespace details:
origin str: The origin of the tag.
tag_keys Sequence[GetTagGroupTagTagKey]: A list containing the tag key details:
tag_values Sequence[GetTagGroupTagTagValue]: A list containing the tag value details:

namespaces List<Property Map>: A list containing the tag namespace details:
origin String: The origin of the tag.
tagKeys List<Property Map>: A list containing the tag key details:
tagValues List<Property Map>: A list containing the tag value details:

GetTagGroupTagNamespace

Enabled bool: Whether the tag key is enabled.
Id string: The ID of the tag group.
Name string: The name of the tag group.

Enabled bool: Whether the tag key is enabled.
Id string: The ID of the tag group.
Name string: The name of the tag group.

enabled bool: Whether the tag key is enabled.
id string: The ID of the tag group.
name string: The name of the tag group.

enabled Boolean: Whether the tag key is enabled.
id String: The ID of the tag group.
name String: The name of the tag group.

enabled boolean: Whether the tag key is enabled.
id string: The ID of the tag group.
name string: The name of the tag group.

enabled bool: Whether the tag key is enabled.
id str: The ID of the tag group.
name str: The name of the tag group.

enabled Boolean: Whether the tag key is enabled.
id String: The ID of the tag group.
name String: The name of the tag group.

GetTagGroupTagTagKey

Enabled bool: Whether the tag key is enabled.
Id string: The ID of the tag group.
Name string: The name of the tag group.

Enabled bool: Whether the tag key is enabled.
Id string: The ID of the tag group.
Name string: The name of the tag group.

enabled bool: Whether the tag key is enabled.
id string: The ID of the tag group.
name string: The name of the tag group.

enabled Boolean: Whether the tag key is enabled.
id String: The ID of the tag group.
name String: The name of the tag group.

enabled boolean: Whether the tag key is enabled.
id string: The ID of the tag group.
name string: The name of the tag group.

enabled bool: Whether the tag key is enabled.
id str: The ID of the tag group.
name str: The name of the tag group.

enabled Boolean: Whether the tag key is enabled.
id String: The ID of the tag group.
name String: The name of the tag group.

GetTagGroupTagTagValue

Id string: The ID of the tag group.
Name string: The name of the tag group.

Id string: The ID of the tag group.
Name string: The name of the tag group.

id string: The ID of the tag group.
name string: The name of the tag group.

id String: The ID of the tag group.
name String: The name of the tag group.

id string: The ID of the tag group.
name string: The name of the tag group.

id str: The ID of the tag group.
name str: The name of the tag group.

id String: The ID of the tag group.
name String: The name of the tag group.

Package Details

Repository: zpa zscaler/pulumi-zpa
License: MIT
Notes: This Pulumi package is based on the zpa Terraform Provider.

Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler

Schema (JSON)

zscaler/pulumi-zpa

zpa.getTagGroup

On this page

On this page

Example Usage

Using getTagGroup

getTagGroup Result

Supporting Types

GetTagGroupTag

GetTagGroupTagNamespace

GetTagGroupTagTagKey

GetTagGroupTagTagValue

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

zpa.getTagGroup

On this page

On this page

Example Usage

Using getTagGroup

getTagGroup Result

Supporting Types

GetTagGroupTag

GetTagGroupTagNamespace

GetTagGroupTagTagKey

GetTagGroupTagTagValue

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.