Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the tag definition.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

description

description: string

The description you assign to the tag.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the tag definition.

Optional isCostTracking

isCostTracking: undefined | false | true

Indicates whether the tag is enabled for cost tracking.

isRetired

isRetired: boolean

Indicates whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.

Optional lifecycleState

lifecycleState: LifecycleState

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

name

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

tagNamespaceId

tagNamespaceId: string

The OCID of the namespace that contains the tag definition.

tagNamespaceName

tagNamespaceName: string

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

timeCreated

timeCreated: Date

Date and time the tag was created, in the format defined by RFC3339.

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

Optional validator

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Tag): object

getJsonObj

  • getJsonObj(obj: Tag): object