Azure IoT Central V3 (Preview)

  • Reference

Azure IoT Central makes it easy to connect, monitor, and manage your IoT devices at scale. With the IoT Central V3 connector, you can trigger workflows when a rule has fired, and take actions by executing commands, updating properties, getting telemetry from devices, and more. Use this connector with your Azure IoT Central V3 application.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Azure IoT Central Technical Support
URL https://aka.ms/iotcentral-create-technical-support-ticket-trial
Connector Metadata
Publisher Microsoft Corporation
Website https://azure.microsoft.com/services/iot-central/
Privacy policy https://privacy.microsoft.com
Categories Internet of Things

The Azure IoT Central V3 connector can be used to connect your Azure IoT Central V3 application to your workflows. You can use the connector to run workflows when a rule is fired. You can use it to get the latest information from your IoT devices such as telemetry data and properties. And you can also use it to update your IoT devices by sending commands, and updating properites.

Prerequisites

  • You must be a user in an Azure IoT Central V3 Pay-As-You-Go application to use this connector.
  • You must use an Azure Active Directory work or school account.

How to get credentials

To add this connector to your workflow, you must first sign into the Azure Active Directory work or school account that is a user in the Azure IoT Central application you want to connect to.

Release notes

September 2021

  • Azure IoT Central V3 connector has now been updated to align with our generally available 1.0 REST API surface. All of the connector actions now support our DTDLv2 format and support for DTDLv1 based models is being deprecated.
  • The actions to Run a device command, Get/Update device properties, and Get device telemetry value have been updated to add support to the latest device template features in Azure IoT Central. These actions now support both root and component capabilities.
  • A new set of device module actions has been added. These actions allow the creation of workflows that interact with Commands, Properties, Telemetries of both device modules and module components.
  • Actions to Get/Create/Update/Delete a device have been updated to align with the latest Azure IoT Central REST API.
  • The actions Get device cloud properties and Update device cloud properties are now part of Get device properties and Update device properties. The new actions enable workflows to interact with both Device Properties and Cloud Properties simultaneously.

Deprecation notice: by the end of CY21, the actions marked as deprecated in the list below will no longer be available when building new workflows. Existing workflows referencing these actions will continue to work until March 2022. We encourage you to update your workflows to take advantage of the newly announced actions that are now supported within Azure IoT Central.

November 2021

  • New actions have been added for listing devices and device templates for an Azure IoT Central application. These actions include pagination support.
  • A new set of user management actions has been added to the connector, allowing workflows to create, update, list, and delete users of an application.
  • Workflows can now get the latest execution of a device command using the new Get device command response actions. This set of actions supports root, component, and module commands.

Known issues and limitations

  • To use this connector in Microsoft Power Automate, you must have signed into the IoT Central application at least once. Otherwise the application won't appear in the Application dropdown
  • Microsoft personal accounts (such as @hotmail.com, @live.com, @outlook.com domains) are not supported to sign into the IoT Central connector. You must use an Azure Active Directory work or school account.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create or update a device

Create a new device or update an existing one by device ID.
Create or update a device (deprecated)

Create a new device or update an existing one by device ID (deprecated).
Create user

Create a user in the application
Delete a device

Delete an existing device by device ID.
Delete a device (deprecated)

Delete an existing device by device ID (deprecated).
Delete a device template

Delete an existing device template by ID.
Delete user

Delete a user
Execute a device command (deprecated)

Execute a command on a device (deprecated).
Get a device by ID

Get details about an existing device by device ID.
Get a device by ID (deprecated)

Get details about an existing device by device ID (deprecated).
Get a device template by ID

Get details about an existing device template by ID.
Get component command response

Get the last response for a device component command.
Get component telemetry value

Get the last telemetry value from a component.
Get device cloud properties (deprecated)

Get all cloud property values of a device by device ID (deprecated).
Get device command response

Get the last response for a device command.
Get device properties

Get all property values of a device by device ID.
Get device properties (deprecated)

Get all property values of a device by device ID (deprecated).
Get device telemetry value

Get the last telemetry value from a device.
Get device telemetry value (deprecated)

Get the last telemetry value from a device (deprecated).
Get module command response

Get the last response for a device module command
Get module component command response

Get the last response for a module component command.
Get module component telemetry value

Get the last telemetry value from a module component.
Get module properties

Get all property values of a module.
Get module telemetry value

Get the last telemetry value from a module.
Get role

Get a role by ID.
Get user

Get a user by ID
List device templates

Get the list of device templates in an application.
List devices

Get the list of devices in an application.
List roles

Get the list of roles in an application.
List users

Get the list of users in an application
Run a component command

Run a command on a component.
Run a device command

Run a command on a device.
Run a module command

Run a command on a module.
Run a module component command

Run a command on a module component.
Update device cloud properties (deprecated)

Update all cloud property values of a device by device ID (deprecated).
Update device properties

Update all property values of a device by device ID.
Update device properties (deprecated)

Update all property values of a device by device ID (deprecated).
Update module properties

Update all property values of a module.
Update user

Update a user in the application via patch

Create or update a device

Operation ID:
Devices_Set_V1

Create a new device or update an existing one by device ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device ID
 id string

Unique ID of the device.
Device Name
 displayName string

Display name of the device.
Device Template
 template string

The device template definition for the device.
Simulated
 simulated boolean

Whether the device is simulated.
Enabled
 enabled boolean

Whether the device connection to IoT Central has been enabled.
Provisioned
 provisioned boolean

Whether resources have been allocated for the device.

Returns

Body
DeviceV1

Create or update a device (deprecated)

Operation ID:
Devices_Set

Create a new device or update an existing one by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device ID
 id string

Unique ID of the device.
Device Name
 displayName string

Display name of the device.
Device Template
 instanceOf string

The device template definition for the device.
Simulated
 simulated boolean

Whether the device is simulated.
Approved
 approved boolean

Whether the device has been approved to connect to IoT Central.
Provisioned
 provisioned boolean

Whether resources have been allocated for the device.

Returns

Body
Device

Create user

Operation ID:
Users_Create_V1

Create a user in the application

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
User
 user_id True string

Unique ID of the user.
User type
 user_type string

Type of the user.
Body
 body True dynamic

User create body.

Returns

The outputs of this operation are dynamic.

Delete a device

Operation ID:
Devices_Remove_V1

Delete an existing device by device ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.

Delete a device (deprecated)

Operation ID:
Devices_Remove

Delete an existing device by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.

Delete a device template

Operation ID:
DeviceTemplates_Remove_V1

Delete an existing device template by ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Template
 template_id True string

Unique ID of the template.

Delete user

Operation ID:
Users_Remove_V1

Delete a user

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
User
 user_id True string

Unique ID of the user.

Execute a device command (deprecated)

Operation ID:
Devices_ExecuteComponentCommand

Execute a command on a device (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Component
 component_name True string

Name of the device component.
Device Command
 command_name True string

Name of this device command.
Device Template
 instanceOf string

The device template definition for the device.
body
 body True dynamic

Device command body.

Returns

The outputs of this operation are dynamic.

Get a device by ID

Operation ID:
Devices_Get_V1

Get details about an existing device by device ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.

Returns

Body
DeviceV1

Get a device by ID (deprecated)

Operation ID:
Devices_Get

Get details about an existing device by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.

Returns

Body
Device

Get a device template by ID

Operation ID:
DeviceTemplates_Get_V1

Get details about an existing device template by ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Template
 template_id True string

Unique ID of the template.

Returns

Body
DeviceTemplateV1

Get component command response

Operation ID:
Devices_GetComponentCommandResponse_V1

Get the last response for a device component command.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Component
 component_name True string

Name of the device component.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get component telemetry value

Operation ID:
Devices_GetComponentTelemetryValue_V1

Get the last telemetry value from a component.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Component
 component_name True string

Name of the device component.
Device Telemetry
 telemetry_name True string

Name of this device telemetry.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device cloud properties (deprecated)

Operation ID:
Devices_GetCloudProperties

Get all cloud property values of a device by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Template
 instanceOf string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device command response

Operation ID:
Devices_GetCommandResponse_V1

Get the last response for a device command.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device properties

Operation ID:
Devices_GetProperties_V1

Get all property values of a device by device ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device properties (deprecated)

Operation ID:
Devices_GetProperties

Get all property values of a device by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Template
 instanceOf string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device telemetry value

Operation ID:
Devices_GetTelemetryValue_V1

Get the last telemetry value from a device.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Telemetry
 telemetry_name True string

Name of this device telemetry.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device telemetry value (deprecated)

Operation ID:
Devices_GetComponentTelemetryValue

Get the last telemetry value from a device (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Component
 component_name True string

Name of the device component.
Device Telemetry
 telemetry_name True string

Name of this device telemetry.
Device Template
 instanceOf string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get module command response

Operation ID:
Devices_GetModuleCommandResponse_V1

Get the last response for a device module command

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get module component command response

Operation ID:
Devices_GetModuleComponentCommandResponse_V1

Get the last response for a module component command.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Component
 component_name True string

Name of the device component.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get module component telemetry value

Operation ID:
Devices_GetModuleComponentTelemetryValue_V1

Get the last telemetry value from a module component.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Component
 component_name True string

Name of the device component.
Device Telemetry
 telemetry_name True string

Name of this device telemetry.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get module properties

Operation ID:
Devices_GetModuleProperties_V1

Get all property values of a module.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get module telemetry value

Operation ID:
Devices_GetModuleTelemetryValue_V1

Get the last telemetry value from a module.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Telemetry
 telemetry_name True string

Name of this device telemetry.
Device Template
 template string

The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get role

Operation ID:
Roles_Get_V1

Get a role by ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Role
 role_id True string

Unique ID for the role.

Returns

Body
RoleV1

Get user

Operation ID:
Users_Get_V1

Get a user by ID

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
User
 user_id True string

Unique ID of the user.

Returns

Body
UserStaticV1

List device templates

Operation ID:
DeviceTemplates_List_V1

Get the list of device templates in an application.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.

Returns

Body
DeviceTemplateCollectionV1

List devices

Operation ID:
Devices_List_V1

Get the list of devices in an application.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.

Returns

Body
DeviceCollectionV1

List roles

Operation ID:
Roles_List_V1

Get the list of roles in an application.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.

Returns

Body
RoleCollectionV1

List users

Operation ID:
Users_List_V1

Get the list of users in an application

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.

Returns

Body
UserCollectionV1

Run a component command

Operation ID:
Devices_RunComponentCommand_V1

Run a command on a component.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Component
 component_name True string

Name of the device component.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.
body
 body True dynamic

Device command body.

Returns

The outputs of this operation are dynamic.

Run a device command

Operation ID:
Devices_RunCommand_V1

Run a command on a device.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.
body
 body True dynamic

Device command body.

Returns

The outputs of this operation are dynamic.

Run a module command

Operation ID:
Devices_RunModuleCommand_V1

Run a command on a module.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.
body
 body True dynamic

Device command body.

Returns

The outputs of this operation are dynamic.

Run a module component command

Operation ID:
Devices_RunModuleComponentCommand_V1

Run a command on a module component.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Component
 component_name True string

Name of the device component.
Device Command
 command_name True string

Name of this device command.
Device Template
 template string

The device template definition for the device.
body
 body True dynamic

Device command body.

Returns

The outputs of this operation are dynamic.

Update device cloud properties (deprecated)

Operation ID:
Devices_UpdateCloudProperties

Update all cloud property values of a device by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Template
 instanceOf string

The device template definition for the device.
body
 body True dynamic

Device properties.

Returns

The outputs of this operation are dynamic.

Update device properties

Operation ID:
Devices_UpdateProperties_V1

Update all property values of a device by device ID.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Template
 template string

The device template definition for the device.
body
 body True dynamic

Device properties.

Returns

The outputs of this operation are dynamic.

Update device properties (deprecated)

Operation ID:
Devices_UpdateProperties

Update all property values of a device by device ID (deprecated).

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Template
 instanceOf string

The device template definition for the device.
body
 body True dynamic

Device properties.

Returns

The outputs of this operation are dynamic.

Update module properties

Operation ID:
Devices_UpdateModuleProperties_V1

Update all property values of a module.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Device
 device_id True string

Unique ID of the device.
Device Module
 module True string

Name of the device module.
Device Template
 template string

The device template definition for the device.
body
 body True dynamic

Device properties.

Returns

The outputs of this operation are dynamic.

Update user

Operation ID:
Users_Update_V1

Update a user in the application via patch

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
User
 user_id True string

Unique ID of the user.
User type
 user_type string

Type of the user.
Body
 body True dynamic

User update body.

Returns

The outputs of this operation are dynamic.

Triggers

When a rule is fired

Create an action which triggers when a rule is fired in IoT Central.

When a rule is fired

Operation ID:
Workflow_CreateTrigger

Create an action which triggers when a rule is fired in IoT Central.

Parameters

Name Key Required Type Description
Application
 application True string

Unique ID of the application.
Workflow Trigger ID
 id string

Unique ID of the workflow trigger.
Rule
 rule True string

Unique ID of the rule that is tied to the workflow trigger.

Returns

The outputs of this operation are dynamic.

Definitions

Device

Name Path Type Description
Device ID
 id string

Unique ID of the device.
Device Name
 displayName string

Display name of the device.
Device Template
 instanceOf string

The device template definition for the device.
Simulated
 simulated boolean

Whether the device is simulated.
Approved
 approved boolean

Whether the device has been approved to connect to IoT Central.
Provisioned
 provisioned boolean

Whether resources have been allocated for the device.

DeviceV1

Name Path Type Description
Device ID
 id string

Unique ID of the device.
Device Name
 displayName string

Display name of the device.
Device Template
 template string

The device template definition for the device.
Simulated
 simulated boolean

Whether the device is simulated.
Enabled
 enabled boolean

Whether the device connection to IoT Central has been enabled.
Provisioned
 provisioned boolean

Whether resources have been allocated for the device.

DeviceCollectionV1

Name Path Type Description
value
 value array of DeviceV1

The collection of devices.
nextLink
 nextLink string

URL to get the next page of devices.

DeviceTemplateV1

Name Path Type Description
Device Template ID
 @id string

Unique ID of the device template.
Device Template Types
 @type array of string

The JSON-LD types of this device template.
Device Template Name
 displayName string

Display name of the device template.
Device Template Description
 description string

Detailed description of the device template.
Device Template Capability Model
 capabilityModel

The capability model utilized by this device template.

DeviceTemplateCollectionV1

Name Path Type Description
value
 value array of DeviceTemplateV1

The collection of device templates.
nextLink
 nextLink string

URL to get the next page of device templates.

RoleV1

Name Path Type Description
id
 id string

Unique ID of the role.
displayName
 displayName string

Display name of the role.

RoleCollectionV1

Name Path Type Description
value
 value array of RoleV1

The collection of roles.

UserStaticV1

Name Path Type Description
User ID
 id string

Unique ID of the user.
User type
 type string

Type of the user.
Roles
 roles array of RoleAssignmentV1

List of role assignments that specify the permissions to access the application.

UserCollectionV1

Name Path Type Description
Users
 value array of UserStaticV1

The collection of users.

RoleAssignmentV1

Name Path Type Description
Role
 role string

ID of the role for this role assignment.