Service - Purge Command Queue

Deletes all the pending commands for this device from the IoT hub.
Deletes all the pending commands for this device from the IoT hub

DELETE https://fully-qualified-iothubname.azure-devices.net/devices/{id}/commands?api-version=2018-06-30

URI Parameters

Name In Required Type Description
id
path True
  • string

Device ID.

api-version
query True
  • string

Version of the Api.

Responses

Name Type Description
200 OK

OK

Definitions

PurgeMessageQueueResult

Result of a device message queue purge operation.

Name Type Description
deviceId
  • string

The ID of the device whose messages are being purged.

moduleId
  • string

The ID of the device whose messages are being purged.

totalMessagesPurged
  • integer