Oracle Cloud Infrastructure Documentation

Updating an IoT Domain

Update an Internet of Things domain.

    1. On the Domains list page, select the domain that you want to work with. If you need help finding the IoT domains list page or an IoT domain, see Listing IoT Domains.
    2. To update a domain:
      • From the IoT domain list, select any of the following options from the Actions menu at the end of the row for that domain:
        • Copy OCID: Select to copy the OCID for the domain.
        • Move Resource: Select to move the domain to another compartment.
        • Manage Tags: Add one or more tags to the domain, or change the value of an existing tag. Select to add or remove tags. See Resource tags.
        • Delete: Select to delete the domain.
      • Or select the domain name to open its details page. Update the settings as needed by selecting the links or tabs to access various actions and resources associated with the domain. For descriptions of all settings, see Creating an IoT Domain.
    3. Optional: To view the work request for an update, go to the domain, and then select the work request tab.

      Select the work request operation name to view the OCID.

      Select Messages to see the related logs messages, log errors, and the associated resources.

      For more information, see Getting a Work Request's Details for Internet of Things.

  • Use the update option to update the value of an existing IoT domain option. When you update an existing option applied to an IoT domain, you change only the value you can not add a new value to an IoT domain using this update option.

    Use the oci iot domain update command and required parameters to update an IoT domain. You can update a description, display name, free form tags, or defined tags for an IoT domain.

    Use this command to update a description:

    oci iot domain update --iot-domain-id <iot-domain-OCID> --description <your-updated-description>

    Use this command to update a display name. 

    oci iot domain update --iot-domain-id <iot-domain-OCID> --display-name <your-updated-display-name>

    Use this command to update free form tags. For more information, see Understanding Free-form Tags. 

    oci iot domain update --iot-domain-id <iot-domain-OCID> --freeform-tags

    Use this command to update defined tags. For more information, see Working with Defined Tags. 

    oci iot domain update --iot-domain-id <iot-domain-OCID> --defined-tags

    For a complete list of parameters and values for CLI commands, see CLI Command Reference.

  • Run the UpdateIotDomain operation to update an IoT domain.