Share via

az iot du device health

Note

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

Device health-check utilities.

Commands

Name Description Type Status
az iot du device health list

List device health with respect to a target filter.

 Extension GA

az iot du device health list

List device health with respect to a target filter.

az iot du device health list --account
                             --filter
                             --instance
                             [--resource-group]

Examples

List healthy devices in an instance.

az iot du device health list -n {account_name} -i {instance_name} --filter "state eq 'Healthy'"

List unhealthy devices in an instance.

az iot du device health list -n {account_name} -i {instance_name} --filter "state eq 'Unhealthy'"

Show the health state for a target device.

az iot du device health list -n {account_name} -i {instance_name} --filter "deviceId eq 'd0'"

Required Parameters

--account -n

Device Update account name. You can configure the default account name using az config set defaults.adu_account={name}.

Property Value
Parameter group: Account Identifier Arguments
--filter

Device health filter. Supports the properties of state or deviceId. If deviceId is provided moduleId can be optionally specified.

--instance -i

Device Update instance name. You can configure the default instance name using az config set defaults.adu_instance={name}.

Property Value
Parameter group: Account Identifier Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_group={name}.

Property Value
Parameter group: Account Identifier Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False