Vcenter Compute Policies TagUsage Summary

The Vcenter Compute Policies TagUsage Summary schema contains common information about a tag used by a policy.

This schema was added in vSphere API 7.0.3.0.

JSON Example

{
    "policy": "string",
    "policy_name": "string",
    "policy_description": "string",
    "capability": "string",
    "tag_type": "string",
    "tag": "string",
    "tag_name": "string",
    "category_name": "string"
}

string

policy

Required

Identifier of the policy that uses the tag indicated by Vcenter Compute Policies TagUsage Summary.tag.

This property was added in vSphere API 7.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.compute.Policy. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.compute.Policy.

string

policy_name

Optional

Name of the policy indicated by Vcenter Compute Policies TagUsage Summary.policy.

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

string

policy_description

Optional

Description of the policy indicated by Vcenter Compute Policies TagUsage Summary.policy.

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

string

capability

Optional

Capability of the policy indicated by Vcenter Compute Policies TagUsage Summary.policy.

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

string

tag_type

Required

Identifier of the tag type used by the policy indicated by Vcenter Compute Policies TagUsage Summary.policy.

This property was added in vSphere API 7.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.resource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.resource.

string

tag

Required

Identifier of the tag used by the policy indicated by Vcenter Compute Policies TagUsage Summary.policy.

This property was added in vSphere API 7.0.3.0.

When clients pass a value of this schema as a parameter, the property tag_type must contain the actual resource type. When operations return a value of this schema as a response, the property tag_type will contain the actual resource type.

string

tag_name

Required

Name of the tag used by the policy indicated by Vcenter Compute Policies TagUsage Summary.policy.

This property was added in vSphere API 7.0.3.0.

string

category_name

Required

Name of the category that has Vcenter Compute Policies TagUsage Summary.tag.

This property was added in vSphere API 7.0.3.0.