Oracle Cloud Infrastructure Documentation

Retiring a Tag Key Definition

Learn how to retire a tag key definition on Private Cloud Appliance.

When you retire a tag key definition, you cannot apply tags that are based on this tag key definition to resources. Existing tag defaults that are based on this tag key definition will not be automatically applied to newly created resources. However, the tag is not removed from resources where it was already applied. The tag still exists as metadata on those resources and you can still use the retired tag in operations such as listing, sorting, and reporting.

    1. In the navigation menu, select Governance, and then select Tag Namespaces.

      If the tag namespace where you want to retire a tag key definition is not listed, use the Compartment drop-down menu above the tag namespaces list to select the correct compartment.

    2. Select the name of the tag namespace where you want to retire a tag key definition.

    3. On the tag namespace details page, scroll down to the Resources section and select Tag Key Definitions.

    4. For the tag key definition that you want to retire, select the Actions menu and select the Retire option.

    5. At the Retire Tag Key Definition confirmation prompt, select Confirm.

  • Use the oci iam tag retire command and required parameters to retire a tag key definition.

    Example:

    oci iam tag retire --tag-name text --tag-namespace-id tag_namespace_OCID

    For a complete list of CLI commands, flags, and options, see the Command Line Reference.

  • On Private Cloud Appliance, retiring a tag key definition by using the API is not supported.

    For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.