vSphere v4.9.0, Nov 28 23

vSphere v4.9.0 published on Tuesday, Nov 28, 2023 by Pulumi

vsphere.Tag

Explore with Pulumi AI

vSphere v4.9.0 published on Tuesday, Nov 28, 2023 by Pulumi

Create Tag Resource

new Tag(name: string, args: TagArgs, opts?: CustomResourceOptions);

@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        category_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None)
@overload
def Tag(resource_name: str,
        args: TagArgs,
        opts: Optional[ResourceOptions] = 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.

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.

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 v4.9.0 published on Tuesday, Nov 28, 2023 by Pulumi

pulumi/pulumi-vsphere

vsphere.Tag

On this page

On this page

Create Tag Resource

Tag Resource Properties

Inputs

Outputs

Look up Existing Tag Resource

Package Details

On this page

On this page