az_iot_hub_client_options Struct Reference

Azure IoT Hub Client options. More...

#include <az_iot_hub_client.h>

Data Fields
az_span	module_id
az_span	user_agent
az_span	model_id
az_span *	component_names
int32_t	component_names_length

Detailed Description

Azure IoT Hub Client options.

Field Documentation

component_names

az_span* az_iot_hub_client_options::component_names

The array of component names for this device.

component_names_length

int32_t az_iot_hub_client_options::component_names_length

The number of component names in the component_names array.

model_id

az_span az_iot_hub_client_options::model_id

The model ID used to identify the capabilities of a device based on the Digital Twin document.

module_id

az_span az_iot_hub_client_options::module_id

The module name (if a module identity is used). Must conform to the requirements of the MQTT spec for topic names (listed below) and of the IoT Hub (listed below) http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties

user_agent

az_span az_iot_hub_client_options::user_agent

The user-agent is a formatted string that will be used for Azure IoT usage statistics.

---

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

• sdk/inc/azure/iot/az_iot_hub_client.h