Show / Hide Table of Contents

Class TagSummary

A tag definition that belongs to a specific tag namespace.

Inheritance
object
TagSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class TagSummary

Properties

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains the tag definition.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

The description you assign to the tag.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the tag definition.

IsCostTracking

Declaration
[JsonProperty(PropertyName = "isCostTracking")]
public bool? IsCostTracking { get; set; }
Property Value
Type Description
bool?

Indicates whether the tag is enabled for cost tracking.

IsRetired

Declaration
[JsonProperty(PropertyName = "isRetired")]
public bool? IsRetired { get; set; }
Property Value
Type Description
bool?

Whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public Tag.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Tag.LifecycleStateEnum?

The tag's current state. After creating a tag, make sure its lifecycleState is ACTIVE before using it. After retiring a tag, make sure its lifecycleState is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's lifecycleState changes from DELETING to DELETED.

Name

Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed.

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

Date and time the tag was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

In this article
Back to top