Class TagDefault

Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types in a specified compartment. The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged. The TagDefault object specifies the tag and compartment details.
Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment for a tenancy, all resources that are created in the tenancy are tagged. For more information about using tag defaults, see Managing Tag Defaults.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.

Inheritance

object

TagDefault

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 TagDefault

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. The tag default applies to all new resources that get created in the compartment. Resources that existed before the tag default was created are not tagged.

Remarks

Required

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 default.

Remarks

Required

IsRequired

Declaration

[Required(ErrorMessage = "IsRequired is required.")]
[JsonProperty(PropertyName = "isRequired")]
public bool? IsRequired { get; set; }

Property Value

Type Description

Type	Description
bool?	If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. If the `isRequired` flag is set to "true", the value is set during resource creation. If the `isRequired` flag is set to "false", the value you enter is set during resource creation. Example: false

bool?

If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

If the isRequired flag is set to "true", the value is set during resource creation.
If the isRequired flag is set to "false", the value you enter is set during resource creation.
Example: false

Remarks

Required

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TagDefault.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
TagDefault.LifecycleStateEnum?	The tag default's current state. After creating a `TagDefault`, make sure its `lifecycleState` is ACTIVE before using it.

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

TagDefinitionId

Declaration

[Required(ErrorMessage = "TagDefinitionId is required.")]
[JsonProperty(PropertyName = "tagDefinitionId")]
public string TagDefinitionId { get; set; }

Property Value

Type	Description
string	The OCID of the tag definition. The tag default will always assign a default value for this tag definition.

Remarks

Required

TagDefinitionName

Declaration

[Required(ErrorMessage = "TagDefinitionName is required.")]
[JsonProperty(PropertyName = "tagDefinitionName")]
public string TagDefinitionName { get; set; }

Property Value

Type	Description
string	The name used in the tag definition. This field is informational in the context of the tag default.

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 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 `TagDefault` object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

Value

Declaration

[Required(ErrorMessage = "Value is required.")]
[JsonProperty(PropertyName = "value")]
public string Value { get; set; }

Property Value

Type	Description
string	The default value for the tag definition. This will be applied to all resources created in the compartment.

Remarks

Required