TaggingTagModel

The TagModel structure defines a tag that can be attached to vSphere objects.


Properties

string
category_id Required

The identifier of the parent category in which this tag will be created. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Category.


string
description Required

The description of the tag.


string
id Required

The unique identifier of the tag. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Tag.


string
name Required

The display name of the tag.


array of string
used_by Required

The set of users that can use this tag. To add users to this, you need to have the edit privilege on the tag. Similarly, to unsubscribe from this tag, you need the edit privilege on the tag. You should not modify other users subscription from this set.

JSON Example

{
    "category_id": "string",
    "description": "string",
    "id": "string",
    "name": "string",
    "used_by": [
        "string"
    ]
}
Returned By

Get Tag
Feedback

Was this page helpful?