Updating a device
Warning
Yandex IoT Core is no longer available to new users.
Current users can create resources until November 1, 2026. Afterwards, the service will go read-only and cease to operate on December 1, 2026. For more information on the timing and procedure, see Service shutdown.
You can update the name or description of a device.
To access a device, use its unique ID or name. For information about how to get its unique ID or name, see Getting information about devices.
Updating device names
To update the name of a device:
- In the management console
, select the folder to update the device name in. - Navigate to IoT Core.
- Select the required registry from the list.
- Select Devices in the left pane of the window.
- To the right of the device name, click
and select Edit from the drop-down list. - Edit the Name field.
- Click Save.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
Update a device description:
yc iot device update my-device --new-name test-device
Result:
id: b9135goeh1uc********
registry_id: b91ki3851hab********
created_at: "2019-05-28T16:08:30.938Z"
name: test-device
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.
To update the name of a device created using Terraform:
-
Open the Terraform configuration file and edit the
nameparameter value in the device description fragment:Example device description in the Terraform configuration:
resource "yandex_iot_core_device" "my_device" { registry_id = "<registry_ID>" name = "test-device" description = "test device for terraform provider documentation" ... }For more information about
yandex_iot_core_deviceproperties, see this Terraform provider guide. -
In the command line, change to the folder where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validateIf the configuration is valid, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.
-
Apply the configuration changes:
terraform apply -
Confirm the changes: type
yesinto the terminal and press Enter.You can check the updated device name in the management console
or using this CLI command:yc iot device list --registry-id <registry_ID>
To rename a device, use the update REST API method for the Device resource or the DeviceService/Update gRPC API call.
Updating device descriptions
To update the description of a device:
- In the management console
, select the folder to update the device description in. - Navigate to IoT Core.
- Select the required registry from the list.
- Select Devices in the left pane of the window.
- To the right of the device name, click
and select Edit from the drop-down list. - Edit the Description field.
- Click Save.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
Update a device description:
yc iot device update my-device --description "My first device."
Result:
id: b9135goeh1uc********
registry_id: b91ki3851hab********
created_at: "2019-05-28T16:08:30.938Z"
name: my-device
description: My first device.
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.
To update the name of a device created using Terraform:
-
Open the Terraform configuration file and edit the
descriptionparameter value in the device description fragment.Example device description in the Terraform configuration:
resource "yandex_iot_core_device" "my_device" { registry_id = "<registry_ID>" name = "test-device" description = "test device for terraform provider documentation" ... }For more information about
yandex_iot_core_deviceproperties, see this Terraform provider guide. -
In the command line, change to the folder where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validateIf the configuration is valid, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.
-
Apply the configuration changes:
terraform apply -
Confirm the changes: type
yesinto the terminal and press Enter.You can check the updated device description in the management console
or using this CLI command:yc iot device get <device_name>
To update a device description, use the update REST API method for the Device resource or the DeviceService/Update gRPC API call.