Share via


az iot du device

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 du device command. Learn more about extensions.

Device Update device management.

Commands

Name Description Type Status
az iot du device class

Device class and device class subgroup management.

Extension GA
az iot du device class delete

Delete a device class or device class subgroup.

Extension GA
az iot du device class list

List device classes or device class subgroups.

Extension GA
az iot du device class show

Show details about a device class or device class subgroup including installable updates, the best update and update compliance.

Extension GA
az iot du device class update

Update a device class.

Extension GA
az iot du device compliance

Instance-view device compliance utilities.

Extension GA
az iot du device compliance show

Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.

Extension GA
az iot du device deployment

Device deployment management.

Extension GA
az iot du device deployment cancel

Cancel a device class subgroup deployment.

Extension GA
az iot du device deployment create

Create a deployment for a device group. The deployment will be multi-cast against every device class subgroup within the target group.

Extension GA
az iot du device deployment delete

Delete a deployment by device group or device class subgroup.

Extension GA
az iot du device deployment list

List deployments for a device group or device class subgroup.

Extension GA
az iot du device deployment list-devices

List devices in a device class subgroup deployment along with their state. Useful for getting a list of failed devices.

Extension GA
az iot du device deployment retry

Retry a device class subgroup deployment.

Extension GA
az iot du device deployment show

Show a deployment for a device group or device class subgroup including status which details a breakdown of how many devices in the deployment are in progress, completed, or failed.

Extension GA
az iot du device group

Device group management.

Extension GA
az iot du device group delete

Delete a device group.

Extension GA
az iot du device group list

List device groups within an instance.

Extension GA
az iot du device group show

Show details about a device group including the best update and update compliance.

Extension GA
az iot du device health

Device health-check utilities.

Extension GA
az iot du device health list

List device health with respect to a target filter.

Extension GA
az iot du device import

Import devices and modules to the Device Update instance from a linked IoT Hub.

Extension GA
az iot du device list

List device identities contained within an instance.

Extension GA
az iot du device log

Instance log collection management.

Extension GA
az iot du device log collect

Configure a device diagnostics log collection operation on specified devices.

Extension GA
az iot du device log list

List instance diagnostic log collection operations.

Extension GA
az iot du device log show

Show a specific instance diagnostic log collection operation.

Extension GA
az iot du device module

Device module management.

Extension GA
az iot du device module show

Show a device module identity imported to the instance.

Extension GA
az iot du device show

Show a device identity contained within an instance.

Extension GA

az iot du device import

Import devices and modules to the Device Update instance from a linked IoT Hub.

az iot du device import --account
                        --instance
                        [--import-type {All, Devices, Modules}]
                        [--resource-group]

Examples

Import devices and modules into a target instance.

az iot du device import -n {account_name} -i {instance_name}

Import only devices.

az iot du device import -n {account_name} -i {instance_name} --import-type Devices

Import only modules.

az iot du device import -n {account_name} -i {instance_name} --import-type Modules

Required Parameters

--account -n

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

--instance -i

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

Optional Parameters

--import-type --it

The types of devices to import from IoT Hub.

Accepted values: All, Devices, Modules
Default value: All
--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_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 du device list

List device identities contained within an instance.

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

Examples

List device identities within a target instance.

az iot du device list -n {account_name} -i {instance_name}

List device identities within a target instance filtering by a desired group Id.

az iot du device list -n {account_name} -i {instance_name} --filter "groupId eq 'myDeviceGroup'"

Required Parameters

--account -n

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

--instance -i

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

Optional Parameters

--filter

Restricts the set of devices returned. You can filter on groupId, deviceClassId, or groupId and deploymentStatus.

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_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 du device show

Show a device identity contained within an instance.

az iot du device show --account
                      --device-id
                      --instance
                      [--resource-group]

Examples

Show a device identity within a target instance.

az iot du device show -n {account_name} -i {instance_name} -d {device_id}

Required Parameters

--account -n

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

--device-id -d

Target Device Id.

--instance -i

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

Optional Parameters

--resource-group -g

Device Update account resource group name. You can configure the default group using az config set defaults.adu_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.