Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. TagCategory
vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.TagCategory

Explore with Pulumi AI

vsphere logo
vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
pulumi/pulumi-vsphere

    The vsphere.TagCategory resource can be used to create and manage tag categories, which determine how tags are grouped together and applied to specific objects.

    For more information about tags, click here.

    Example Usage

    This example creates a tag category named test-category, with single cardinality (meaning that only one tag in this category can be assigned to an object at any given time). Tags in this category can only be assigned to VMs and datastores.

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

const category = new vsphere.TagCategory("category", {
    name: "test-category",
    description: "Managed by Pulumi",
    cardinality: "SINGLE",
    associableTypes: [
        "VirtualMachine",
        "Datastore",
    ],
});

    import pulumi
import pulumi_vsphere as vsphere

category = vsphere.TagCategory("category",
    name="test-category",
    description="Managed by Pulumi",
    cardinality="SINGLE",
    associable_types=[
        "VirtualMachine",
        "Datastore",
    ])

    package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vsphere.NewTagCategory(ctx, "category", &vsphere.TagCategoryArgs{
			Name:        pulumi.String("test-category"),
			Description: pulumi.String("Managed by Pulumi"),
			Cardinality: pulumi.String("SINGLE"),
			AssociableTypes: pulumi.StringArray{
				pulumi.String("VirtualMachine"),
				pulumi.String("Datastore"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var category = new VSphere.TagCategory("category", new()
    {
        Name = "test-category",
        Description = "Managed by Pulumi",
        Cardinality = "SINGLE",
        AssociableTypes = new[]
        {
            "VirtualMachine",
            "Datastore",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.TagCategory;
import com.pulumi.vsphere.TagCategoryArgs;
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) {
        var category = new TagCategory("category", TagCategoryArgs.builder()
            .name("test-category")
            .description("Managed by Pulumi")
            .cardinality("SINGLE")
            .associableTypes(            
                "VirtualMachine",
                "Datastore")
            .build());

    }
}

    resources:
  category:
    type: vsphere:TagCategory
    properties:
      name: test-category
      description: Managed by Pulumi
      cardinality: SINGLE
      associableTypes:
        - VirtualMachine
        - Datastore

    Create TagCategory Resource

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

    Constructor syntax

    new TagCategory(name: string, args: TagCategoryArgs, opts?: CustomResourceOptions);
    @overload
def TagCategory(resource_name: str,
                args: TagCategoryArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def TagCategory(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                associable_types: Optional[Sequence[str]] = None,
                cardinality: Optional[str] = None,
                description: Optional[str] = None,
                name: Optional[str] = None)
    func NewTagCategory(ctx *Context, name string, args TagCategoryArgs, opts ...ResourceOption) (*TagCategory, error)
    public TagCategory(string name, TagCategoryArgs args, CustomResourceOptions? opts = null)
    public TagCategory(String name, TagCategoryArgs args)
public TagCategory(String name, TagCategoryArgs args, CustomResourceOptions options)

    type: vsphere:TagCategory
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 TagCategoryArgs
    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 TagCategoryArgs
    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 TagCategoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagCategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagCategoryArgs
    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 tagCategoryResource = new VSphere.TagCategory("tagCategoryResource", new()
{
    AssociableTypes = new[]
    {
        "string",
    },
    Cardinality = "string",
    Description = "string",
    Name = "string",
});

    example, err := vsphere.NewTagCategory(ctx, "tagCategoryResource", &vsphere.TagCategoryArgs{
	AssociableTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Cardinality: pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var tagCategoryResource = new TagCategory("tagCategoryResource", TagCategoryArgs.builder()
    .associableTypes("string")
    .cardinality("string")
    .description("string")
    .name("string")
    .build());

    tag_category_resource = vsphere.TagCategory("tagCategoryResource",
    associable_types=["string"],
    cardinality="string",
    description="string",
    name="string")

    const tagCategoryResource = new vsphere.TagCategory("tagCategoryResource", {
    associableTypes: ["string"],
    cardinality: "string",
    description: "string",
    name: "string",
});

    type: vsphere:TagCategory
properties:
    associableTypes:
        - string
    cardinality: string
    description: string
    name: string

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

    AssociableTypes List<string>
    A list object types that this category is valid to be assigned to. For a full list, click here.
    Cardinality string
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    Description string

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    Name string
    The name of the category.
    AssociableTypes []string
    A list object types that this category is valid to be assigned to. For a full list, click here.
    Cardinality string
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    Description string

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    Name string
    The name of the category.
    associableTypes List<String>
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality String
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description String

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name String
    The name of the category.
    associableTypes string[]
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality string
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description string

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name string
    The name of the category.
    associable_types Sequence[str]
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality str
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description str

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name str
    The name of the category.
    associableTypes List<String>
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality String
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description String

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name String
    The name of the category.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TagCategory 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TagCategory Resource

    Get an existing TagCategory 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?: TagCategoryState, opts?: CustomResourceOptions): TagCategory
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associable_types: Optional[Sequence[str]] = None,
        cardinality: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> TagCategory
    func GetTagCategory(ctx *Context, name string, id IDInput, state *TagCategoryState, opts ...ResourceOption) (*TagCategory, error)
    public static TagCategory Get(string name, Input<string> id, TagCategoryState? state, CustomResourceOptions? opts = null)
    public static TagCategory get(String name, Output<String> id, TagCategoryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AssociableTypes List<string>
    A list object types that this category is valid to be assigned to. For a full list, click here.
    Cardinality string
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    Description string

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    Name string
    The name of the category.
    AssociableTypes []string
    A list object types that this category is valid to be assigned to. For a full list, click here.
    Cardinality string
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    Description string

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    Name string
    The name of the category.
    associableTypes List<String>
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality String
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description String

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name String
    The name of the category.
    associableTypes string[]
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality string
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description string

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name string
    The name of the category.
    associable_types Sequence[str]
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality str
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description str

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name str
    The name of the category.
    associableTypes List<String>
    A list object types that this category is valid to be assigned to. For a full list, click here.
    cardinality String
    The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
    description String

    A description for the category.

    NOTE: You can add associable types to a category, but you cannot remove them. Attempting to do so will result in an error.

    name String
    The name of the category.

    Import

    An existing tag category can be imported into this resource via

    its name, using the following command:

    $ pulumi import vsphere:index/tagCategory:TagCategory category terraform-test-category

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

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
    pulumi/pulumi-vsphere