Docs Packages
  1. Packages
  2. vSphere
  3. API Docs
  4. Tag
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.Tag

Explore with Pulumi AI

vsphere logo
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

    Create Tag Resource

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

    Constructor syntax

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

@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        category_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None)
    func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
    public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
    public Tag(String name, TagArgs args)
public Tag(String name, TagArgs args, CustomResourceOptions options)

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

    example, err := vsphere.NewTag(ctx, "tagResource", &vsphere.TagArgs{
	CategoryId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var tagResource = new Tag("tagResource", TagArgs.builder()
    .categoryId("string")
    .description("string")
    .name("string")
    .build());

    tag_resource = vsphere.Tag("tagResource",
    category_id="string",
    description="string",
    name="string")

    const tagResource = new vsphere.Tag("tagResource", {
    categoryId: "string",
    description: "string",
    name: "string",
});

    type: vsphere:Tag
properties:
    categoryId: string
    description: string
    name: string

    Tag Resource Properties

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

    Inputs

    The Tag resource accepts the following input properties:

    CategoryId string
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    Description string
    A description for the tag.
    Name string
    The display name of the tag. The name must be unique within its category.
    CategoryId string
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    Description string
    A description for the tag.
    Name string
    The display name of the tag. The name must be unique within its category.
    categoryId String
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description String
    A description for the tag.
    name String
    The display name of the tag. The name must be unique within its category.
    categoryId string
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description string
    A description for the tag.
    name string
    The display name of the tag. The name must be unique within its category.
    category_id str
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description str
    A description for the tag.
    name str
    The display name of the tag. The name must be unique within its category.
    categoryId String
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description String
    A description for the tag.
    name String
    The display name of the tag. The name must be unique within its category.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Tag 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 Tag Resource

    Get an existing Tag 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?: TagState, opts?: CustomResourceOptions): Tag
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> Tag
    func GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)
    public static Tag Get(string name, Input<string> id, TagState? state, CustomResourceOptions? opts = null)
    public static Tag get(String name, Output<String> id, TagState 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:
    CategoryId string
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    Description string
    A description for the tag.
    Name string
    The display name of the tag. The name must be unique within its category.
    CategoryId string
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    Description string
    A description for the tag.
    Name string
    The display name of the tag. The name must be unique within its category.
    categoryId String
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description String
    A description for the tag.
    name String
    The display name of the tag. The name must be unique within its category.
    categoryId string
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description string
    A description for the tag.
    name string
    The display name of the tag. The name must be unique within its category.
    category_id str
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description str
    A description for the tag.
    name str
    The display name of the tag. The name must be unique within its category.
    categoryId String
    The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
    description String
    A description for the tag.
    name String
    The display name of the tag. The name must be unique within its category.

    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.10.1 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-vsphere