Azure SDK for Embedded C
Data Fields
az_iot_adu_client_device_properties Struct Reference

Holds the ADU agent device properties. More...

#include <az_iot_adu_client.h>

Data Fields

az_span manufacturer
 
az_span model
 
az_iot_adu_device_custom_propertiescustom_properties
 
az_span adu_version
 
az_span delivery_optimization_agent_version
 
az_span update_id
 

Detailed Description

Holds the ADU agent device properties.

az_iot_adu_client_device_properties_default() must be called to first initialize the device properties.

Remarks
These properties are used by the ADU service for matching update groups and verifying the current update deployed. https://docs.microsoft.com/azure/iot-hub-device-update/device-update-plug-and-play

Field Documentation

◆ adu_version

az_span az_iot_adu_client_device_properties::adu_version

Version of the Device Update agent running on the device.

Remarks
Must be set to AZ_IOT_ADU_CLIENT_AGENT_VERSION.

◆ custom_properties

az_iot_adu_device_custom_properties* az_iot_adu_client_device_properties::custom_properties

Implementer can define other device properties to be used for the compatibility check while targeting the update deployment.

◆ delivery_optimization_agent_version

az_span az_iot_adu_client_device_properties::delivery_optimization_agent_version

Version of the Delivery Optimization agent.

Remarks
Please see Azure Device Update documentation on how to use the delivery optimization agent. If unused, set to AZ_SPAN_EMPTY.

https://docs.microsoft.com/azure/iot-hub-device-update/device-update-plug-and-play#device-properties

◆ manufacturer

az_span az_iot_adu_client_device_properties::manufacturer

The device manufacturer of the device, reported through deviceProperties.

◆ model

az_span az_iot_adu_client_device_properties::model

The device model of the device, reported through deviceProperties.

◆ update_id

az_span az_iot_adu_client_device_properties::update_id

An ID of the update that is currently installed.


The documentation for this struct was generated from the following file: