Class Tag
A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before
you can apply them to resources.
For more information, see Managing Tags and Tag Namespaces.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values
using the API.
Inherited Members
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class Tag
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment that contains the tag definition. |
Remarks
Required
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.
|
Description
Declaration
[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | The description you assign to the tag. |
Remarks
Required
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.
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the tag definition. |
Remarks
Required
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
[Required(ErrorMessage = "IsRetired is required.")]
[JsonProperty(PropertyName = "isRetired")]
public bool? IsRetired { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether the tag is retired. See Retiring Key Definitions and Namespace Definitions. |
Remarks
Required
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Tag.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Tag.LifecycleStateEnum? | The tag's current state. After creating a tag, make sure its |
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[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. |
Remarks
Required
TagNamespaceId
Declaration
[Required(ErrorMessage = "TagNamespaceId is required.")]
[JsonProperty(PropertyName = "tagNamespaceId")]
public string TagNamespaceId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the namespace that contains the tag definition. |
Remarks
Required
TagNamespaceName
Declaration
[Required(ErrorMessage = "TagNamespaceName is required.")]
[JsonProperty(PropertyName = "tagNamespaceName")]
public string TagNamespaceName { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the tag namespace that contains the tag definition. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[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.
|
Remarks
Required
Validator
Declaration
[JsonProperty(PropertyName = "validator")]
public BaseTagDefinitionValidator Validator { get; set; }
Property Value
Type | Description |
---|---|
BaseTagDefinitionValidator |