az iot hub device-identity children

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.32.0 or higher). The extension will automatically install the first time you run an az iot hub device-identity children command. Learn more about extensions.

Manage children device relationships for IoT edge devices.

Commands

az iot hub device-identity children add

Add devices as children to a target edge device.

az iot hub device-identity children list

Outputs the collection of assigned child devices.

az iot hub device-identity children remove

Remove child devices from a target edge device.

az iot hub device-identity children add

Add devices as children to a target edge device.

az iot hub device-identity children add --child-list
                                        --device-id
                                        [--auth-type {key, login}]
                                        [--force]
                                        [--hub-name]
                                        [--login]
                                        [--resource-group]

Examples

Add a space-separated list of device Ids as children to the target edge device.

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name}

Add devices as children to the edge device and overwrite the children devices' existing parent.

az iot hub device-identity children add -d {edge_device_id} --child-list {child_device_id_1} {child_device_id_2} -n {iothub_name} -f

Required Parameters

--child-list --cl

Child device list (space separated).

--device-id -d

Id of edge device.

Optional Parameters

--auth-type

Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.

accepted values: key, login
default value: key
--force -f

Overwrites the child device's parent device.

--hub-name -n

IoT Hub name. Required if --login is not provided.

--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az iot hub device-identity children list

Outputs the collection of assigned child devices.

az iot hub device-identity children list --device-id
                                         [--auth-type {key, login}]
                                         [--hub-name]
                                         [--login]
                                         [--resource-group]

Examples

List all assigned children devices.

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name}

List all assigned children devices whose device Id contains a substring of 'test'.

az iot hub device-identity children list -d {edge_device_id} -n {iothub_name} --query "[?contains(@,'test')]"

Required Parameters

--device-id -d

Id of edge device.

Optional Parameters

--auth-type

Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.

accepted values: key, login
default value: key
--hub-name -n

IoT Hub name. Required if --login is not provided.

--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az iot hub device-identity children remove

Remove child devices from a target edge device.

az iot hub device-identity children remove --device-id
                                           [--auth-type {key, login}]
                                           [--child-list]
                                           [--hub-name]
                                           [--login]
                                           [--remove-all]
                                           [--resource-group]

Examples

Remove a space-seperated list of child devices from a target parent device.

az iot hub device-identity children remove -d {edge_device_id} --child-list {space_separated_device_id} -n {iothub_name}

Remove all child devices from a target parent device.

az iot hub device-identity children remove -d {edge_device_id} --remove-all

Required Parameters

--device-id -d

Id of edge device.

Optional Parameters

--auth-type

Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.

accepted values: key, login
default value: key
--child-list --cl

Child device list (space separated).

--hub-name -n

IoT Hub name. Required if --login is not provided.

--login -l

This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.

--remove-all -a

To remove all children.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.