Azure SDK for Embedded C
Data Fields
az_iot_provisioning_client_register_response Struct Reference

Register or query operation response. More...

#include <az_iot_provisioning_client.h>

Data Fields

az_iot_status status
 
az_span operation_id
 
az_span operation_status
 
uint32_t retry_after_seconds
 
az_iot_provisioning_client_registration_state registration_result
 

Detailed Description

Register or query operation response.

Field Documentation

◆ operation_id

az_span az_iot_provisioning_client_register_response::operation_id

Operation ID of the register operation.

◆ operation_status

az_span az_iot_provisioning_client_register_response::operation_status

An az_span containing the status of the register operation. This can be one of the following: unassigned, assigning, assigned, failed, disabled. az_iot_provisioning_client_parse_operation_status() can optionally be used to convert this into the az_iot_provisioning_client_operation_status enum.

◆ registration_result

az_iot_provisioning_client_registration_state az_iot_provisioning_client_register_response::registration_result

If the operation is complete (success or error), the registration state will contain the hub and device id in case of success.

◆ retry_after_seconds

uint32_t az_iot_provisioning_client_register_response::retry_after_seconds

Recommended timeout before sending the next MQTT publish.

◆ status

az_iot_status az_iot_provisioning_client_register_response::status

The current request status.

Remarks
The authoritative response for the device registration operation (which may require several requests) is available only through operation_status.

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