Show / Hide Table of Contents

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
System.Object
TagDefault
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class TagDefault : object

Properties

CompartmentId

Declaration
public string CompartmentId { get; set; }
Property Value
Type Description
System.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
public string Id { get; set; }
Property Value
Type Description
System.String

The OCID of the tag default.

Remarks

Required

IsRequired

Declaration
public System.Nullable<bool> IsRequired { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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 &quot;true&quot;, the value is set during resource creation.
  • If the isRequired flag is set to &quot;false&quot;, the value you enter is set during resource creation.
    Example: false
Remarks

Required

LifecycleState

Declaration
public System.Nullable<TagDefault.LifecycleStateEnum> LifecycleState { get; set; }
Property Value
Type Description
System.Nullable<TagDefault.LifecycleStateEnum>

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

Locks

Declaration
public System.Collections.Generic.List<ResourceLock> Locks { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ResourceLock>

Locks associated with this resource.

TagDefinitionId

Declaration
public string TagDefinitionId { get; set; }
Property Value
Type Description
System.String

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

Remarks

Required

TagDefinitionName

Declaration
public string TagDefinitionName { get; set; }
Property Value
Type Description
System.String

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

Remarks

Required

TagNamespaceId

Declaration
public string TagNamespaceId { get; set; }
Property Value
Type Description
System.String

The OCID of the tag namespace that contains the tag definition.

Remarks

Required

TimeCreated

Declaration
public System.Nullable<System.DateTime> TimeCreated { get; set; }
Property Value
Type Description
System.Nullable<System.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
public string Value { get; set; }
Property Value
Type Description
System.String

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

Remarks

Required

In This Article
Back to top