Azure IoT Central V2

This is a legacy connector for Azure IoT Central V2 applications that will become deprecated in the future. You should use the Azure IoT Central V3 connector and applications instead. Azure IoT Central makes it easy to connect, monitor, and manage your IoT devices at scale. With the IoT Central V2 connector, you can trigger flows when a rule has fired and take action by creating new devices, updating existing devices, and deleting devices.

Status: Preview

Tier: Premium

Version: 1.0.0

Actions:

Name	Summary
Actions_List (string application_id)	Get the list of actions in an application
Actions_Schema (string application_id, [Optional]string type, [Optional]string ruleId)
Actions_Get (string application_id, string action_id)	Get an action by ID
Actions_Remove (string application_id, string action_id)	Delete an action
DeviceCommands_Run (string application_id, string device_id, string device_command_id, DeviceCommandParameters body, [Optional]string deviceTemplateDisplayId)	Run a command
Devices_List (string application_id, [Optional]string deviceTemplateDisplayId)	Get the list of devices in an application
Devices_Create (string application_id, Device body, [Optional]string deviceTemplateDisplayId)	Create a device
Devices_Schema (string application_id, [Optional]string id, [Optional]string deviceTemplateDisplayId)
Devices_Get (string application_id, string device_id, [Optional]string deviceTemplateDisplayId)	Get a device
Devices_Update (string application_id, string device_id, DeviceUpdate body, [Optional]string deviceTemplateDisplayId)	Update a device
Devices_Remove (string application_id, string device_id)	Delete a device
Devices_Definition (string application_id, string device_id, [Optional]string deviceTemplateDisplayId)
Dps_Details (string application_id)	Get the DPS environment
Rules_List (string application_id)	Get the list of rules in an application
Rules_Get (string application_id, string rule_id)	Get a rule by ID
Applications_List ()	Get the list of applications accessible to the signed-in user
Applications_Get (string application_id)	Get an application by ID
DeviceCommandDisplay_List (string application_id, string device_template_display_id)
DeviceCommandDisplay_Definition (string application_id, string device_template_display_id, string device_command_id)
DeviceTemplateDisplay_List (string application_id)

Triggers:

Name	Summary
Actions_Create (string application_id, Action body, [internal][Optional]string user-agent, [internal][Optional]string x-ms-workflow-name)	When a rule is fired

Objects:

Name	Summary
Action
ActionCollection
Application
ApplicationCollection
Attestation
CaReferences
Device
DeviceCollection
DeviceCommandParameters
DeviceMeasurements
DeviceProperties
DevicePropertiesUpdate
DeviceSettings
DeviceSettingsUpdate
DeviceTemplateReference
DeviceTemplateReferenceUpdate
DeviceUpdate
DisplayEntity
DisplayEntityCollection
DpsEnvironment
EnrollmentGroup
Rule
RuleCollection
SymmetricKey
TPM
X509

Actions:

Actions_List

Summary: Get the list of actions in an application

Description:

Syntax:

AzureIoTCentralV2.Actions_List (string application_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

Returns:

Type:ActionCollection

Actions_Schema

Summary:

Description:

Syntax:

AzureIoTCentralV2.Actions_Schema (string application_id, [Optional]string type, [Optional]string ruleId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
type	string		False
ruleId	string		False

Returns:

Actions_Get

Summary: Get an action by ID

Description:

Syntax:

AzureIoTCentralV2.Actions_Get (string application_id, string action_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

action_id

string

(Action)

Unique ID of the action.

True

Actions_List

Returns:

Type:Action

Actions_Remove

Summary: Delete an action

Description:

Syntax:

AzureIoTCentralV2.Actions_Remove (string application_id, string action_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

action_id

string

(Action)

Unique ID of the action.

True

Actions_List

Returns:

DeviceCommands_Run

Summary: Run a command

Description: Run a command by ID on a device.

Syntax:

AzureIoTCentralV2.DeviceCommands_Run (string application_id, string device_id, string device_command_id, DeviceCommandParameters body, [Optional]string deviceTemplateDisplayId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
device_id	string (Device)	Unique ID of the device.	True
device_command_id	string (Command)	ID of the command.	True	DeviceCommandDisplay_List
body	DeviceCommandParameters		True
deviceTemplateDisplayId	string (Device Template)	Device template associated with this device.	False	DeviceTemplateDisplay_List

Returns:

Devices_List

Summary: Get the list of devices in an application

Description:

Syntax:

AzureIoTCentralV2.Devices_List (string application_id, [Optional]string deviceTemplateDisplayId)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

deviceTemplateDisplayId

string

(Device Template)

Device template associated with this device.

False

DeviceTemplateDisplay_List

Returns:

Type:DeviceCollection

Devices_Create

Summary: Create a device

Description: Create a new real or simulated device of a specified device template.

Syntax:

AzureIoTCentralV2.Devices_Create (string application_id, Device body, [Optional]string deviceTemplateDisplayId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
body	Device		True
deviceTemplateDisplayId	string (Device Template)	Device template associated with this device.	False	DeviceTemplateDisplay_List

Returns:

Type:Device

Devices_Schema

Summary:

Description:

Syntax:

AzureIoTCentralV2.Devices_Schema (string application_id, [Optional]string id, [Optional]string deviceTemplateDisplayId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
id	string		False
deviceTemplateDisplayId	string (Device Template)	Device template associated with this device.	False	DeviceTemplateDisplay_List

Returns:

Devices_Get

Summary: Get a device

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

Syntax:

AzureIoTCentralV2.Devices_Get (string application_id, string device_id, [Optional]string deviceTemplateDisplayId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
device_id	string (Device)	Unique ID of the device.	True
deviceTemplateDisplayId	string (Device Template)	Device template associated with this device.	False	DeviceTemplateDisplay_List

Returns:

Type:Device

Devices_Update

Summary: Update a device

Description: Update an existing device by device ID.

Syntax:

AzureIoTCentralV2.Devices_Update (string application_id, string device_id, DeviceUpdate body, [Optional]string deviceTemplateDisplayId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
device_id	string (Device)	Unique ID of the device.	True
body	DeviceUpdate		True
deviceTemplateDisplayId	string (Device Template)	Device template associated with this device.	False	DeviceTemplateDisplay_List

Returns:

Type:Device

Devices_Remove

Summary: Delete a device

Description: Delete an existing device by device ID.

Syntax:

AzureIoTCentralV2.Devices_Remove (string application_id, string device_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

device_id

string

(Device)

Unique ID of the device.

True

Returns:

Devices_Definition

Summary:

Description:

Syntax:

AzureIoTCentralV2.Devices_Definition (string application_id, string device_id, [Optional]string deviceTemplateDisplayId)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
device_id	string (Device)	Unique ID of the device.	True
deviceTemplateDisplayId	string (Device Template)	Device template associated with this device.	False	DeviceTemplateDisplay_List

Returns:

Dps_Details

Summary: Get the DPS environment

Description:

Syntax:

AzureIoTCentralV2.Dps_Details (string application_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

Returns:

Type:DpsEnvironment

Rules_List

Summary: Get the list of rules in an application

Description:

Syntax:

AzureIoTCentralV2.Rules_List (string application_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

Returns:

Type:RuleCollection

Rules_Get

Summary: Get a rule by ID

Description:

Syntax:

AzureIoTCentralV2.Rules_Get (string application_id, string rule_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

rule_id

string

(Rule)

Unique ID of the rule.

True

Rules_List

Returns:

Type:Rule

Applications_List

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

Description:

Syntax:

AzureIoTCentralV2.Applications_List ()

Returns:

Type:ApplicationCollection

Applications_Get

Summary: Get an application by ID

Description:

Syntax:

AzureIoTCentralV2.Applications_Get (string application_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

Returns:

Type:Application

DeviceCommandDisplay_List

Summary:

Description:

Syntax:

AzureIoTCentralV2.DeviceCommandDisplay_List (string application_id, string device_template_display_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

device_template_display_id

string

True

Returns:

Type:DisplayEntityCollection

DeviceCommandDisplay_Definition

Summary:

Description:

Syntax:

AzureIoTCentralV2.DeviceCommandDisplay_Definition (string application_id, string device_template_display_id, string device_command_id)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
device_template_display_id	string		True
device_command_id	string		True

Returns:

DeviceTemplateDisplay_List

Summary:

Description:

Syntax:

AzureIoTCentralV2.DeviceTemplateDisplay_List (string application_id)

Parameters:

Name

Type

Summary

Required

Related Action

application_id

string

(Application)

Unique ID of the application.

True

Applications_List

Returns:

Type:DisplayEntityCollection

Triggers:

Trigger Actions_Create

Summary: When a rule is fired

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

Syntax:

AzureIoTCentralV2.Actions_Create (string application_id, Action body, [internal][Optional]string user-agent, [internal][Optional]string x-ms-workflow-name)

Parameters:

Name	Type	Summary	Required	Related Action
application_id	string (Application)	Unique ID of the application.	True	Applications_List
body	Action		True
user-agent	string		False
x-ms-workflow-name	string		False

Returns:

Type:Action

Action

Summary:

Description:

Properties:

Name	Type	Summary
id	string Action ID	Unique ID of the action.
ruleId	string Rule	Unique ID of the rule that is tied to the action.
type	string Action Type	Type of the action. Values: [flow]
url	string

ActionCollection

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (Action)

Application

Summary:

Description:

Properties:

Name	Type	Summary
id	string Application ID	Unique ID of the application.
name	string Application Name	Display name of the application.
subdomain	string Application Subdomain	Subdomain of the application.

ApplicationCollection

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (Application)

Attestation

Summary:

Description:

Properties:

Name	Type	Summary
type	string	Values: [tpm, x509, symmetricKey]
tpm	TPM
x509	X509
symmetricKey	SymmetricKey

CaReferences

Summary:

Description:

Properties:

Name

Type

Summary

primary

string

secondary

string

Device

Summary:

Description:

Properties:

Name	Type	Summary
id	string Device ID	Unique ID of the device in IoT Central.
name	string Device Name	Display name of the device.
simulated	boolean Device Simulated	Simulated flag of the device. True if device is simulated.
deviceId	string Device Connection ID	ID used for device connectivity.
deviceTemplate	DeviceTemplateReference
properties	DeviceProperties
settings	DeviceSettings
measurements	DeviceMeasurements

DeviceCollection

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (Device)

DeviceCommandParameters

Summary:

Description:

Properties:

Name

Type

Summary

DeviceMeasurements

Summary:

Description:

Properties:

Name	Type	Summary
telemetry	Telemetry
events	Events
states	States

Telemetry

Summary:

Description:

Properties:

Name

Type

Summary

Events

Summary:

Description:

Properties:

Name

Type

Summary

States

Summary:

Description:

Properties:

Name

Type

Summary

DeviceProperties

Summary:

Description:

Properties:

Name

Type

Summary

device

Device

cloud

Cloud

Device

Summary:

Description:

Properties:

Name

Type

Summary

Cloud

Summary:

Description:

Properties:

Name

Type

Summary

DevicePropertiesUpdate

Summary:

Description:

Properties:

Name

Type

Summary

cloud

Cloud

Summary:

Description:

Properties:

Name

Type

Summary

DeviceSettings

Summary:

Description:

Properties:

Name

Type

Summary

device

Device

Summary:

Description:

Properties:

Name

Type

Summary

DeviceSettingsUpdate

Summary:

Description:

Properties:

Name

Type

Summary

device

Device

Summary:

Description:

Properties:

Name

Type

Summary

DeviceTemplateReference

Summary:

Description:

Properties:

Name

Type

Summary

string

Device Template ID

Unique ID of the device template.

version

string

Device Template Version

Version of the device template.

DeviceTemplateReferenceUpdate

Summary:

Description:

Properties:

Name

Type

Summary

string

Device Template ID

Unique ID of the device template.

version

string

Device Template Version

Version of the device template.

DeviceUpdate

Summary:

Description:

Properties:

Name	Type	Summary
name	string Device Name	Display name of the device.
simulated	boolean Device Simulated	Simulated flag of the device. True if device is simulated.
deviceId	string Device Connection ID	ID used for device connectivity.
deviceTemplate	DeviceTemplateReferenceUpdate
properties	DevicePropertiesUpdate
settings	DeviceSettingsUpdate

DisplayEntity

Summary:

Description:

Properties:

Name

Type

Summary

string

name

string

DisplayEntityCollection

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (DisplayEntity)

DpsEnvironment

Summary:

Description:

Properties:

Name	Type	Summary
idScope	string
deviceProvisioningHostName	string
enrollmentGroups	array of (EnrollmentGroup)

EnrollmentGroup

Summary:

Description:

Properties:

Name	Type	Summary
enrollmentGroupId	string
provisioningStatus	string	Values: [enabled, disabled]
attestation	Attestation

Rule

Summary:

Description:

Properties:

Name	Type	Summary
id	string Rule ID	Unique ID of the rule.
name	string Rule Name	Display name of the rule.
enabled	boolean Rule Enabled	Enabled flag of the rule. True if rule is enabled.
deviceTemplate	DeviceTemplateReference

RuleCollection

Summary:

Description:

Properties:

Name

Type

Summary

value

array of (Rule)

SymmetricKey

Summary:

Description:

Properties:

Name

Type

Summary

primaryKey

string

secondaryKey

string

TPM

Summary:

Description:

Properties:

Name

Type

Summary

endorsementKey

string

storageRootKey

string

X509

Summary:

Description:

Properties:

Name

Type

Summary

caReferences

CaReferences