Connectors Reference

Azure IoT Central V3

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.

 

Status: Preview

Tier: Premium

Version: preview

 

Actions:

Name

Summary

Applications_List ()

Get the list of applications accessible to the signed-in user

DeviceTemplates_List (string application)

Get the list of device templates in an application

Devices_Get (string application, string device_id)

Get a device by ID

Devices_Set (string application, string device_id, Device body)

Create or update a device

Devices_Remove (string application, string device_id)

Delete a device

Rules_List (string application)

Get the list of rules in an application

Devices_GetCloudProperties (string application, string device_id, [Optional]string instanceOf)

Get device cloud properties

Devices_UpdateCloudProperties (string application, string device_id, [Optional]string instanceOf, DeviceCloudProperties body)

Update device cloud properties

Devices_ExecuteComponentCommand (string application, string device_id, string component_name, string command_name, [Optional]string instanceOf, DeviceCommand body)

Execute a device command

Devices_GetProperties (string application, string device_id, [Optional]string instanceOf)

Get device properties

Devices_UpdateProperties (string application, string device_id, [Optional]string instanceOf, DeviceProperties body)

Update device properties

Devices_GetComponentTelemetryValue (string application, string device_id, string component_name, string telemetry_name, [Optional]string instanceOf)

Get device telemetry value

Schema_DeviceProperties (string application, [Optional]string instanceOf)

 

Schema_DeviceCloudProperties (string application, [Optional]string instanceOf)

 

Schema_DeviceTelemetry (string application, [Optional]string instanceOf, [Optional]string component, [Optional]string capability)

 

Schema_DeviceCommand (string application, [Optional]string instanceOf, [Optional]string component, [Optional]string capability)

 

Schema_WebhookActionBody (string application, [Optional]string rule)

 

Schema_Definition (string application, string type)

 

Workflow_GetTrigger (string application, string trigger_id)

 

Workflow_RemoveTrigger (string application, string trigger_id)

 

Workflow_GetComponents (string application, string template)

 

Workflow_GetCapabilities (string application, string template, [Optional]string component, [Optional]string type)

 

 

Triggers:

Name

Summary

Workflow_CreateTrigger (string application, WorkflowTrigger body)

When a rule is fired

 

Objects:

Name

Summary

Application

 

ApplicationCollection

 

Device

 

DeviceCloudProperties

Device Cloud Properties

DeviceCommand

 

DeviceProperties

Device Properties

DeviceTelemetry

 

DeviceTemplate

 

DeviceTemplateCollection

 

Rule

 

RuleCollection

 

WorkflowTrigger

 

Workflow_GetComponentsResponseItem

 

 

Actions:

Applications_List

Summary: Get the list of applications accessible to the signed-in user

Description:

 

Syntax:

AzureIoTCentralV3.Applications_List ()

 

Returns:

          Type:ApplicationCollection

 

DeviceTemplates_List

Summary: Get the list of device templates in an application

Description:

 

Syntax:

AzureIoTCentralV3.DeviceTemplates_List (string application)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

 

Returns:

          Type:DeviceTemplateCollection

 

Devices_Get

Summary: Get a device by ID

Description: Get details about an existing device by device ID.

 

Syntax:

AzureIoTCentralV3.Devices_Get (string application, string device_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

 

Returns:

          Type:Device

 

Devices_Set

Summary: Create or update a device

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

 

Syntax:

AzureIoTCentralV3.Devices_Set (string application, string device_id, Device body)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

body

Device

 

 

True

 

Returns:

          Type:Device

 

Devices_Remove

Summary: Delete a device

Description: Delete an existing device by device ID.

 

Syntax:

AzureIoTCentralV3.Devices_Remove (string application, string device_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

 

Returns:

 

Rules_List

Summary: Get the list of rules in an application

Description:

 

Syntax:

AzureIoTCentralV3.Rules_List (string application)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

 

Returns:

          Type:RuleCollection

 

Devices_GetCloudProperties

Summary: Get device cloud properties

Description: Get all cloud property values of a device by device ID.

 

Syntax:

AzureIoTCentralV3.Devices_GetCloudProperties (string application, string device_id, [Optional]string instanceOf)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

 

Returns:

          Type:DeviceCloudProperties

          Summary: Device Cloud Properties

          Description: Cloud property values associated with the device.

 

Devices_UpdateCloudProperties

Summary: Update device cloud properties

Description: Update all cloud property values of a device by device ID.

 

Syntax:

AzureIoTCentralV3.Devices_UpdateCloudProperties (string application, string device_id, [Optional]string instanceOf, DeviceCloudProperties body)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

body

DeviceCloudProperties

(Device Cloud Properties)

Cloud property values associated with the device.

True

 

Returns:

          Type:DeviceCloudProperties

          Summary: Device Cloud Properties

          Description: Cloud property values associated with the device.

 

Devices_ExecuteComponentCommand

Summary: Execute a device command

Description: Execute a command on a device.

 

Syntax:

AzureIoTCentralV3.Devices_ExecuteComponentCommand (string application, string device_id, string component_name, string command_name, [Optional]string instanceOf, DeviceCommand body)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

component_name

string

(Device Component)

Name of the device component.

True

Workflow_GetComponents

command_name

string

(Device Command)

Name of this device command.

True

Workflow_GetCapabilities

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

body

DeviceCommand

 

 

True

 

Returns:

          Type:DeviceCommand

 

Devices_GetProperties

Summary: Get device properties

Description: Get all property values of a device by device ID.

 

Syntax:

AzureIoTCentralV3.Devices_GetProperties (string application, string device_id, [Optional]string instanceOf)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

 

Returns:

          Type:DeviceProperties

          Summary: Device Properties

          Description: Property values associated with the device.

 

Devices_UpdateProperties

Summary: Update device properties

Description: Update all property values of a device by device ID.

 

Syntax:

AzureIoTCentralV3.Devices_UpdateProperties (string application, string device_id, [Optional]string instanceOf, DeviceProperties body)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

body

DeviceProperties

(Device Properties)

Property values associated with the device.

True

 

Returns:

          Type:DeviceProperties

          Summary: Device Properties

          Description: Property values associated with the device.

 

Devices_GetComponentTelemetryValue

Summary: Get device telemetry value

Description: Get the last telemetry value from a device.

 

Syntax:

AzureIoTCentralV3.Devices_GetComponentTelemetryValue (string application, string device_id, string component_name, string telemetry_name, [Optional]string instanceOf)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

component_name

string

(Device Component)

Name of the device component.

True

Workflow_GetComponents

telemetry_name

string

(Device Telemetry)

Name of this device telemetry.

True

Workflow_GetCapabilities

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

 

Returns:

          Type:DeviceTelemetry

 

Schema_DeviceProperties

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Schema_DeviceProperties (string application, [Optional]string instanceOf)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

 

Returns:

 

Schema_DeviceCloudProperties

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Schema_DeviceCloudProperties (string application, [Optional]string instanceOf)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

 

Returns:

 

Schema_DeviceTelemetry

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Schema_DeviceTelemetry (string application, [Optional]string instanceOf, [Optional]string component, [Optional]string capability)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

component

string

 

 

False

capability

string

 

 

False

 

Returns:

 

Schema_DeviceCommand

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Schema_DeviceCommand (string application, [Optional]string instanceOf, [Optional]string component, [Optional]string capability)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

instanceOf

string

(Device Template)

The device template definition for the device.

False

DeviceTemplates_List

component

string

 

 

False

capability

string

 

 

False

 

Returns:

 

Schema_WebhookActionBody

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Schema_WebhookActionBody (string application, [Optional]string rule)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

rule

string

 

 

False

 

Returns:

 

Schema_Definition

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Schema_Definition (string application, string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

type

string

 

 

True

 

Returns:

 

Workflow_GetTrigger

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Workflow_GetTrigger (string application, string trigger_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

trigger_id

string

 

 

True

 

Returns:

          Type:WorkflowTrigger

 

Workflow_RemoveTrigger

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Workflow_RemoveTrigger (string application, string trigger_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

trigger_id

string

 

 

True

 

Returns:

 

Workflow_GetComponents

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Workflow_GetComponents (string application, string template)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

template

string

 

 

True

 

Returns:

          Type:array of (Workflow_GetComponentsResponseItem)

 

Workflow_GetCapabilities

Summary:

Description:

 

Syntax:

AzureIoTCentralV3.Workflow_GetCapabilities (string application, string template, [Optional]string component, [Optional]string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

template

string

 

 

True

component

string

 

 

False

type

string

 

 

False

 

Returns:

          Type:array of (Workflow_GetComponentsResponseItem)

 

Triggers:

Trigger Workflow_CreateTrigger

Summary: When a rule is fired

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

 

Syntax:

AzureIoTCentralV3.Workflow_CreateTrigger (string application, WorkflowTrigger body)

 

Parameters:

Name

Type

Summary

Required

Related Action

application

string

(Application)

Unique ID of the application.

True

Applications_List

body

WorkflowTrigger

 

 

True

 

Returns:

          Type:WorkflowTrigger

 


 

Application

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Application ID

Unique ID of the application.

displayName

string

Application Name

Display name of the application.

subdomain

string

Subdomain

The URL subdomain of the application.

host

string

Host

The URL host of the application.


 

ApplicationCollection

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Application)

 

The collection of applications.

nextLink

string

 

URL to get the next page of applications.


 

Device

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Device ID

Unique ID of the device.

etag

string

Device ETag

ETag used to prevent conflict in device updates.

displayName

string

Device Name

Display name of the device.

instanceOf

string

Device Template

The device template definition for the device.

simulated

boolean

Simulated

Whether the device is simulated.

approved

boolean

Approved

Whether the device has been approved to connect to IoT Central.

provisioned

boolean

Provisioned

Whether resources have been allocated for the device.


 

DeviceCloudProperties

Summary: Device Cloud Properties

Description: Cloud property values associated with the device.

 

          Properties:

Name

Type

Summary


 

DeviceCommand

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Device Command Request ID

The request ID of the device command execution.

request

Request

Device Command Request Payload

The payload for the device command.

response

Response

Device Command Response Payload

The payload of the device command response.

responseCode

integer

Device Command Response Status

The status code of the device command response.

 

Request

Summary: Device Command Request Payload

Description: The payload for the device command.

 

          Properties:

Name

Type

Summary

 

Response

Summary: Device Command Response Payload

Description: The payload of the device command response.

 

          Properties:

Name

Type

Summary

 


 

DeviceProperties

Summary: Device Properties

Description: Property values associated with the device.

 

          Properties:

Name

Type

Summary


 

DeviceTelemetry

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

Value

Value

The last known value of this device telemetry.

timestamp

string(date-time)

Timestamp

String-formatted date representing the time when the telemetry value was sent.

 

Value

Summary: Value

Description: The last known value of this device telemetry.

 

          Properties:

Name

Type

Summary

 


 

DeviceTemplate

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Device Template ID

Unique ID of the device template.

etag

string

Device Template ETag

ETag used to prevent conflict in device template updates.

types

array of (string)

Device Template Types

The types of device to which this template applies.

displayName

string

Device Template Name

Display name of the device template.

description

string

Device Template Description

Detailed description of the device template.


 

DeviceTemplateCollection

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (DeviceTemplate)

 

The collection of device templates.

nextLink

string

 

URL to get the next page of device templates.


 

Rule

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Rule ID

Unique ID of the rule.

displayName

string

Rule Name

Display name of the rule.


 

RuleCollection

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Rule)

 

The collection of rules.

nextLink

string

 

URL to get the next page of rules.


 

WorkflowTrigger

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Workflow Trigger ID

Unique ID of the workflow trigger.

rule

string

Rule

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

url

string(uri)

Workflow Trigger URL

Callback URL of the workflow Trigger.


 

Workflow_GetComponentsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

 

 

title

string