Using Azure IoT Device Management Services
The Azure IoT Extension (AIE) applies the AzureIotHubAdapterServices Thing Shape to the ConnectionServicesHub Thing, providing the following Azure IoT device management services described below.
CreateAzureIotDevice Service
The CreateAzureIotDevice service creates a new Azure IoT device in your Azure IoT Hub. The service takes a thingName input parameter that is the device ID of the Azure IoT device to be created and has no output. The service completes successfully if the Azure IoT device was created or the Azure IoT device already exists.
 |
Running this service does not create a corresponding AzureIotThing Thing in ThingWorx. You can create the AzureIotThing Thing manually or import the Azure IoT device into ThingWorx using the ImportAzureIotDevices service found on the ConnectionServicesHub Thing. For more information, see Importing Device Information from an Azure IoT Hub.
|
DeleteAzureIotDevice Service
The DeleteAzureIotDevice service deletes an Azure IoT device from your Azure IoT Hub. The service takes a thingName input parameter that is the device ID of the Azure IoT device to be deleted and has no output. The service completes successfully if the Azure IoT device was deleted or the Azure IoT device does not exist.
|
|
Running this service does not delete the corresponding AzureIotThing in ThingWorx, if one exists.
|
DescribeAzureIotDevice Service
The DescribeAzureIotDevice service fetches details about an existing Azure IoT device in your Azure IoT Hub. The service takes a thingName parameter that is the device ID of the Azure IoT device to be described and returns an infotable with the AzureIotHubDeviceDataShape Data Shape. The AzureIotHubDeviceDataShape Data Shape contains the following fields:
|
Field Name
|
Description
|
||
|---|---|---|---|
|
status
|
The status of the connected device.
|
||
|
deviceId
|
The unique identifier for the device.
|
||
|
c2dMessageCount
|
The number of cloud-to-device messages sent to the device.
|
||
|
connectionState
|
Indicates whether the device is Connected or Disconnected.
|
||
|
connectionStateUpdatedTime
|
The date and time when the connectionState was last updated.
|
||
|
eTag
|
An entity tag used for device identity.
|
||
|
generationId
|
A string generated by the IoT Hub that is used to distinguish between devices with the same deviceId, if they have been deleted and re-created.
|
||
|
lastActivityTime
|
The date and time of the last activity on the connection.
|
||
|
primaryKey
|
The primary key component of the symmetric key used for authentication.
|
||
|
secondaryKey
|
The secondary key component of the symmetric key used for authentication.
|
||
|
statusReason
|
The reason why the status is Connected or Disconnected.
|
||
|
statusUpdatedTime
|
The last date and time when the connection status was updated.
|
||
|
symmetricKey
|
The primary symmetric key used for authentication by the device.
The type of symmetric key can be: certificateAuthority, none, sas, or selfSigned.
|
For more information, see Devices - Get Devices - REST API (Azure IoT Hub) | Microsoft Learn.