1. Packages
  2. Packages
  3. Zscaler Private Access (ZPA)
  4. API Docs
  5. TagNamespace
Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler
zpa logo
Viewing docs for Zscaler Private Access v1.0.4
published on Monday, Jun 29, 2026 by Zscaler

    The zpa_tag_namespace resource creates and manages tag namespaces in Zscaler Private Access (ZPA).

    NOTE: This an Early Access feature.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    const _this = new zpa.TagNamespace("this", {
        name: "Example Namespace",
        description: "An example tag namespace",
        enabled: true,
    });
    
    import pulumi
    import zscaler_pulumi_zpa as zpa
    
    this = zpa.TagNamespace("this",
        name="Example Namespace",
        description="An example tag namespace",
        enabled=True)
    
    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.NewTagNamespace(ctx, "this", &zpa.TagNamespaceArgs{
    			Name:        pulumi.String("Example Namespace"),
    			Description: pulumi.String("An example tag namespace"),
    			Enabled:     pulumi.Bool(true),
    		})
    		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 = new Zpa.TagNamespace("this", new()
        {
            Name = "Example Namespace",
            Description = "An example tag namespace",
            Enabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.TagNamespace;
    import com.pulumi.zpa.TagNamespaceArgs;
    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) {
            var this_ = new TagNamespace("this", TagNamespaceArgs.builder()
                .name("Example Namespace")
                .description("An example tag namespace")
                .enabled(true)
                .build());
    
        }
    }
    
    resources:
      this:
        type: zpa:TagNamespace
        properties:
          name: Example Namespace
          description: An example tag namespace
          enabled: true
    
    pulumi {
      required_providers {
        zpa = {
          source = "pulumi/zpa"
        }
      }
    }
    
    resource "zpa_tagnamespace" "this" {
      name        = "Example Namespace"
      description = "An example tag namespace"
      enabled     = true
    }
    

    Create TagNamespace Resource

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

    Constructor syntax

    new TagNamespace(name: string, args?: TagNamespaceArgs, opts?: CustomResourceOptions);
    @overload
    def TagNamespace(resource_name: str,
                     args: Optional[TagNamespaceArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def TagNamespace(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     microtenant_id: Optional[str] = None,
                     name: Optional[str] = None,
                     origin: Optional[str] = None,
                     type: Optional[str] = None)
    func NewTagNamespace(ctx *Context, name string, args *TagNamespaceArgs, opts ...ResourceOption) (*TagNamespace, error)
    public TagNamespace(string name, TagNamespaceArgs? args = null, CustomResourceOptions? opts = null)
    public TagNamespace(String name, TagNamespaceArgs args)
    public TagNamespace(String name, TagNamespaceArgs args, CustomResourceOptions options)
    
    type: zpa:TagNamespace
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "zpa_tag_namespace" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TagNamespaceArgs
    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 TagNamespaceArgs
    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 TagNamespaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagNamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagNamespaceArgs
    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 tagNamespaceResource = new Zpa.TagNamespace("tagNamespaceResource", new()
    {
        Description = "string",
        Enabled = false,
        MicrotenantId = "string",
        Name = "string",
        Origin = "string",
        Type = "string",
    });
    
    example, err := zpa.NewTagNamespace(ctx, "tagNamespaceResource", &zpa.TagNamespaceArgs{
    	Description:   pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	MicrotenantId: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	Origin:        pulumi.String("string"),
    	Type:          pulumi.String("string"),
    })
    
    resource "zpa_tag_namespace" "tagNamespaceResource" {
      lifecycle {
        create_before_destroy = true
      }
      description    = "string"
      enabled        = false
      microtenant_id = "string"
      name           = "string"
      origin         = "string"
      type           = "string"
    }
    
    var tagNamespaceResource = new TagNamespace("tagNamespaceResource", TagNamespaceArgs.builder()
        .description("string")
        .enabled(false)
        .microtenantId("string")
        .name("string")
        .origin("string")
        .type("string")
        .build());
    
    tag_namespace_resource = zpa.TagNamespace("tagNamespaceResource",
        description="string",
        enabled=False,
        microtenant_id="string",
        name="string",
        origin="string",
        type="string")
    
    const tagNamespaceResource = new zpa.TagNamespace("tagNamespaceResource", {
        description: "string",
        enabled: false,
        microtenantId: "string",
        name: "string",
        origin: "string",
        type: "string",
    });
    
    type: zpa:TagNamespace
    properties:
        description: string
        enabled: false
        microtenantId: string
        name: string
        origin: string
        type: string
    

    TagNamespace 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 TagNamespace resource accepts the following input properties:

    Description string
    Description of the tag namespace
    Enabled bool
    Whether this tag namespace is enabled
    MicrotenantId string
    Microtenant ID
    Name string
    Name of the tag namespace
    Origin string
    Origin of the tag namespace. Defaults to CUSTOM
    Type string
    Type of the tag namespace. Defaults to STATIC
    Description string
    Description of the tag namespace
    Enabled bool
    Whether this tag namespace is enabled
    MicrotenantId string
    Microtenant ID
    Name string
    Name of the tag namespace
    Origin string
    Origin of the tag namespace. Defaults to CUSTOM
    Type string
    Type of the tag namespace. Defaults to STATIC
    description string
    Description of the tag namespace
    enabled bool
    Whether this tag namespace is enabled
    microtenant_id string
    Microtenant ID
    name string
    Name of the tag namespace
    origin string
    Origin of the tag namespace. Defaults to CUSTOM
    type string
    Type of the tag namespace. Defaults to STATIC
    description String
    Description of the tag namespace
    enabled Boolean
    Whether this tag namespace is enabled
    microtenantId String
    Microtenant ID
    name String
    Name of the tag namespace
    origin String
    Origin of the tag namespace. Defaults to CUSTOM
    type String
    Type of the tag namespace. Defaults to STATIC
    description string
    Description of the tag namespace
    enabled boolean
    Whether this tag namespace is enabled
    microtenantId string
    Microtenant ID
    name string
    Name of the tag namespace
    origin string
    Origin of the tag namespace. Defaults to CUSTOM
    type string
    Type of the tag namespace. Defaults to STATIC
    description str
    Description of the tag namespace
    enabled bool
    Whether this tag namespace is enabled
    microtenant_id str
    Microtenant ID
    name str
    Name of the tag namespace
    origin str
    Origin of the tag namespace. Defaults to CUSTOM
    type str
    Type of the tag namespace. Defaults to STATIC
    description String
    Description of the tag namespace
    enabled Boolean
    Whether this tag namespace is enabled
    microtenantId String
    Microtenant ID
    name String
    Name of the tag namespace
    origin String
    Origin of the tag namespace. Defaults to CUSTOM
    type String
    Type of the tag namespace. Defaults to STATIC

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TagNamespace Resource

    Get an existing TagNamespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TagNamespaceState, opts?: CustomResourceOptions): TagNamespace
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            microtenant_id: Optional[str] = None,
            name: Optional[str] = None,
            origin: Optional[str] = None,
            type: Optional[str] = None) -> TagNamespace
    func GetTagNamespace(ctx *Context, name string, id IDInput, state *TagNamespaceState, opts ...ResourceOption) (*TagNamespace, error)
    public static TagNamespace Get(string name, Input<string> id, TagNamespaceState? state, CustomResourceOptions? opts = null)
    public static TagNamespace get(String name, Output<String> id, TagNamespaceState state, CustomResourceOptions options)
    resources:  _:    type: zpa:TagNamespace    get:      id: ${id}
    import {
      to = zpa_tag_namespace.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the tag namespace
    Enabled bool
    Whether this tag namespace is enabled
    MicrotenantId string
    Microtenant ID
    Name string
    Name of the tag namespace
    Origin string
    Origin of the tag namespace. Defaults to CUSTOM
    Type string
    Type of the tag namespace. Defaults to STATIC
    Description string
    Description of the tag namespace
    Enabled bool
    Whether this tag namespace is enabled
    MicrotenantId string
    Microtenant ID
    Name string
    Name of the tag namespace
    Origin string
    Origin of the tag namespace. Defaults to CUSTOM
    Type string
    Type of the tag namespace. Defaults to STATIC
    description string
    Description of the tag namespace
    enabled bool
    Whether this tag namespace is enabled
    microtenant_id string
    Microtenant ID
    name string
    Name of the tag namespace
    origin string
    Origin of the tag namespace. Defaults to CUSTOM
    type string
    Type of the tag namespace. Defaults to STATIC
    description String
    Description of the tag namespace
    enabled Boolean
    Whether this tag namespace is enabled
    microtenantId String
    Microtenant ID
    name String
    Name of the tag namespace
    origin String
    Origin of the tag namespace. Defaults to CUSTOM
    type String
    Type of the tag namespace. Defaults to STATIC
    description string
    Description of the tag namespace
    enabled boolean
    Whether this tag namespace is enabled
    microtenantId string
    Microtenant ID
    name string
    Name of the tag namespace
    origin string
    Origin of the tag namespace. Defaults to CUSTOM
    type string
    Type of the tag namespace. Defaults to STATIC
    description str
    Description of the tag namespace
    enabled bool
    Whether this tag namespace is enabled
    microtenant_id str
    Microtenant ID
    name str
    Name of the tag namespace
    origin str
    Origin of the tag namespace. Defaults to CUSTOM
    type str
    Type of the tag namespace. Defaults to STATIC
    description String
    Description of the tag namespace
    enabled Boolean
    Whether this tag namespace is enabled
    microtenantId String
    Microtenant ID
    name String
    Name of the tag namespace
    origin String
    Origin of the tag namespace. Defaults to CUSTOM
    type String
    Type of the tag namespace. Defaults to STATIC

    Import

    Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language. Visit

    zpa_tag_namespace can be imported by using <TAG NAMESPACE ID> or <TAG NAMESPACE NAME> as the import ID.

    For example:

    $ pulumi import zpa:index/tagNamespace:TagNamespace example <tag_namespace_id>
    

    or

    $ pulumi import zpa:index/tagNamespace:TagNamespace example <tag_namespace_name>
    

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

    Package Details

    Repository
    zpa zscaler/pulumi-zpa
    License
    MIT
    Notes
    This Pulumi package is based on the zpa Terraform Provider.
    zpa logo
    Viewing docs for Zscaler Private Access v1.0.4
    published on Monday, Jun 29, 2026 by Zscaler

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial