Device

Operations

Abandon Device Bound Notification

This method abandons a cloud-to-device message. The Etag obtained when the message was received must be provided to resolve race conditions when completing, rejecting, or abandoning a message. A abandoned message is put back in the device message queue for re-delivery to the device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. Currently, the use of the Etag in the header does not comply with RFC 7232. A fix for this issue is currently on our backlog. This capability is only available in the standard tier IoT Hub. For more information, see Choose the right IoT Hub tier.

Complete Device Bound Notification

This method completes or rejects a cloud-to-device message. The Etag obtained when the message was received must be provided to resolve race conditions when completing, rejecting, or abandoning a message. A completed message is deleted from the device message queue, and a positive acknowledgment is sent to the application back-end if requested. A rejected message causes it to be deadlettered. To reject a message, include a query parameter called "reject". See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. Currently, the use of the Etag in the header does not comply with RFC 7232. A fix for this issue is currently on our backlog. This capability is only available in the standard tier IoT Hub. For more information, see Choose the right IoT Hub tier.

Create File Upload Sas Uri

This method is used to retrieve a storage SAS URI to upload a file. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload for more information.

Get Device And Module In Scope

Get device registry information using module connect for a specific device in deviceScope. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only.

Get Devices And Modules In Scope

Query IotHub to retrieve information regarding devices which belong to the same deviceScope. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only.

Receive Device Bound Notification

This method is used to retrieve a cloud-to-device message See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see Choose the right IoT Hub tier.

Send Device Event

Send a device-to-cloud message. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information.

Update File Upload Status

This method is used to notify an IoT hub of a completed file upload. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload for more information.