Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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 {@code 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](https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagdefaults.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.

Properties

compartmentId

compartmentId: 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.

id

id: string

The OCID of the tag default.

isRequired

isRequired: 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 {@code isRequired} flag is set to \"true\", the value is set during resource creation. * If the {@code isRequired} flag is set to \"false\", the value you enter is set during resource creation.

Example: {@code false}

Optional lifecycleState

lifecycleState: LifecycleState

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

Optional locks

Locks associated with this resource.

tagDefinitionId

tagDefinitionId: string

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

tagDefinitionName

tagDefinitionName: string

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

tagNamespaceId

tagNamespaceId: string

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

timeCreated

timeCreated: Date

Date and time the {@code TagDefault} object was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

value

value: string

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

Functions

getDeserializedJsonObj

getJsonObj