az iot hub device-identity parent

Note

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

Manage parent device relationships for IoT devices.

Commands

Name	Description	Type	Status
az iot hub device-identity parent set	Set the parent device of a target device.	Extension	GA
az iot hub device-identity parent show	Get the parent device of a target device.	Extension	GA

az iot hub device-identity parent set

Set the parent device of a target device.

az iot hub device-identity parent set --device-id
                                      --parent-device-id
                                      [--auth-type {key, login}]
                                      [--force]
                                      [--hub-name]
                                      [--login]
                                      [--resource-group]

Examples

Set the parent device of a target device.

az iot hub device-identity parent set -d {device_id} --pd {edge_device_id} -n {iothub_name}

Set the parent device of a target device and overwrite the existing parent.

az iot hub device-identity parent set -d {device_id} --pd {edge_device_id} -n {iothub_name} --force

Required Parameters

--device-id -d

Target Device Id.

--parent-device-id --pd

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. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.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 device's parent device.

Default value: False

--hub-name -n

IoT Hub name or hostname. 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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot hub device-identity parent show

Get the parent device of a target device.

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

Examples

Get the parent device of a target device.

az iot hub device-identity parent show -d {device_id} -n {iothub_name}

Required Parameters

--device-id -d

Target Device Id.

Optional Parameters

--auth-type

Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.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 or hostname. 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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.