Azure IoT Central V3 (Preview)

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 Microsoft Entra ID work or school account.

How to get credentials

To add this connector to your workflow, you must first sign into the Microsoft Entra ID 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 Microsoft Entra ID work or school account.

Creating a connection

The connector supports the following authentication types:

Credentials	Credentials	All regions	Not shareable
Default [DEPRECATED]	This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.	All regions	Not shareable

Credentials

Auth ID: 1stparty

Applicable: All regions

Credentials

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

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

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 connection	100	60 seconds

Actions

Create a device group	Create or update a device group.
Create a device relationship	Create a new device relationship between the given device and a new device given a device ID and a relationship ID.
Create a job	Create and execute a new job via its job definition.
Create a scheduled job	Create and execute a new scheduled job via its job definition.
Create an organization	Create a new organization.
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 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 relationship	Delete an existing device relationship by device ID and relationship ID.
Delete a device template	Delete an existing device template by ID.
Delete a scheduled job	Delete an existing scheduled job by ID.
Delete device group	Delete an existing device group by ID
Delete organization	Delete an existing organization 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 group	Get details about an existing device group by ID.
Get a device template by ID	Get details about an existing device template by ID.
Get a job	Get details about an existing job by ID.
Get a scheduled job	Get details about an existing scheduled job by ID.
Get an organization	Get details about an existing organization 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 relationship	Get details about an existing device relationship by device ID and by relationship ID.
Get device statuses	Get the list of individual device statuses by job ID.
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 devices by device group ID	Get the list of devices in a device group in an application.
Get jobs by scheduled job ID	Get the list of jobs for a scheduled job definition.
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 groups	Get the list of device groups in an application.
List device templates	Get the list of device templates in an application.
List devices	Get the list of devices in an application.
List jobs	Get the list of jobs in an application.
List organizations	Get the list of organizations in an application.
List relationships	List all relationships based on device ID.
List roles	Get the list of roles in an application.
List scheduled jobs	Get the list of scheduled jobs in an application.
List users	Get the list of users in an application
Resume a job on failed devices	Execute a rerun of an existing job on all failed devices.
Resume a stopped job	Resume execution of an existing stopped job.
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.
Stop a running job	Stop execution of a job that is currently running.
Update a device relationship	Update an existing device relationship between the given device and a new device given a device ID and a relationship ID.
Update a scheduled job	Update an existing scheduled job by ID.
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 a device group

Operation ID:

DeviceGroups_Set

Create or update a device group.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device Group ID	device_group_id	True	string	Unique ID of the device group.
Device Group ID	id		string	Unique ID of the device group.
Display Name	displayName	True	string	Display name of the device group.
Filter	filter	True	string	Query defining which devices should be in this group.
Description	description		string	Short summary of device group.
ETag	etag		string	ETag used to prevent conflict in device group updates.
Organizations	organizations		array of string	List of organizations of the device group, only one organization is supported today, multiple organizations will be supported soon.

Returns

The device group definition.

Body

DeviceGroup

Create a device relationship

Operation ID:

DeviceRelationships_Set

Create a new device relationship between the given device and a new device given a device ID and a relationship ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Relationship ID	relationship_id	True	string	Unique ID of the device relationship.
Device ID	device_id	True	string	Unique ID of the device.
Device Relationship ID	id		string	Unique ID of the device relationship.
Device Relationship Target ID	target	True	string	The device ID of the source (child) device.

Returns

Body

DeviceRelationshipStatic

Create a job

Operation ID:

Jobs_Set

Create and execute a new job via its job definition.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Job ID	job_id	True	string	Unique ID of the job.
Job type	job_type		string	Type of the job.
Body	body	True	dynamic	Job create body.

Returns

The outputs of this operation are dynamic.

Create a scheduled job

Operation ID:

ScheduledJobs_Set

Create and execute a new scheduled job via its job definition.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Scheduled Job ID	scheduled_job_id	True	string	Unique ID of the scheduled job.
Job type	job_type		string	Type of the job.
Schedule End Type	scheduled_job_end_type		string	How the scheduled job should end (not applied to device template migrations).
Body	body	True	dynamic	Scheduled Job create body.

Returns

The outputs of this operation are dynamic.

Create an organization

Operation ID:

Organizations_Set

Create a new organization.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Organization ID	organization_id	True	string	Unique ID of the organization.
Organization ID	id		string	Unique ID of the organization.
Organization Name	displayName		string	Display name of the organization.
Parent	parent		string	Display name of the parent organization.

Returns

Body

Organization

Create or update a device

Operation ID:

Devices_Set_V2

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 ID	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.
Organizations	organizations		array of string	List of organizations of the device, only one organization is supported today, multiple organizations will be supported soon.
Provisioned	provisioned		boolean	Whether resources have been allocated for the device.

Returns

Body

DeviceV2

Create or update a device (deprecated)

Operation ID:

Devices_Set_V1

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 ID	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 ID	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 ID	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 ID	device_id	True	string	Unique ID of the device.

Delete a device relationship

Operation ID:

DeviceRelationships_Remove

Delete an existing device relationship by device ID and relationship ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device ID	device_id	True	string	Unique ID of the device.
Relationship ID	relationship_id	True	string	Unique ID of the device relationship.

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 a scheduled job

Operation ID:

ScheduledJobs_Remove

Delete an existing scheduled job by ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Scheduled Job ID	scheduled_job_id	True	string	Unique ID of the scheduled job.

Delete device group

Operation ID:

DeviceGroups_Remove

Delete an existing device group by ID

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device Group ID	device_group_id	True	string	Unique ID of the device group.

Delete organization

Operation ID:

Organizations_Remove

Delete an existing organization by ID

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Organization ID	organization_id	True	string	Unique ID of the organization.

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 ID	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 ID	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 ID	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 ID	device_id	True	string	Unique ID of the device.

Returns

Body

Device

Get a device group

Operation ID:

DeviceGroups_Get

Get details about an existing device group by ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device Group ID	device_group_id	True	string	Unique ID of the device group.

Returns

The device group definition.

Body

DeviceGroup

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 a job

Operation ID:

Jobs_Get

Get details about an existing job by ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Job ID	job_id	True	string	Unique ID of the job.

Returns

The job definition.

Body

JobStatic

Get a scheduled job

Operation ID:

ScheduledJobs_Get

Get details about an existing scheduled job by ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Scheduled Job ID	scheduled_job_id	True	string	Unique ID of the scheduled job.

Returns

The outputs of this operation are dynamic.

Get an organization

Operation ID:

Organizations_Get

Get details about an existing organization by ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Organization ID	organization_id	True	string	Unique ID of the organization.

Returns

Body

Organization

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 ID	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 ID	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 ID	device_id	True	string	Unique ID of the device.
Device Template ID	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 ID	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 ID	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 ID	device_id	True	string	Unique ID of the device.
Device Template ID	instanceOf		string	The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get device relationship

Operation ID:

DeviceRelationships_Get

Get details about an existing device relationship by device ID and by relationship ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device ID	device_id	True	string	Unique ID of the device.
Relationship ID	relationship_id	True	string	Unique ID of the device relationship.

Returns

Body

DeviceRelationshipStatic

Get device statuses

Operation ID:

Jobs_GetDevices

Get the list of individual device statuses by job ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Job ID	job_id	True	string	Unique ID of the job.

Returns

The paged results of job device statuses.

Body

JobDeviceStatusCollection

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 ID	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 ID	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 ID	instanceOf		string	The device template definition for the device.

Returns

The outputs of this operation are dynamic.

Get devices by device group ID

Operation ID:

DeviceGroups_GetDevices

Get the list of devices in a device group in an application.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device Group ID	device_group_id	True	string	Unique ID of the device group.

Returns

The paged results of devices belonging to the device group.

Body

DeviceGroupDeviceCollection

Get jobs by scheduled job ID

Operation ID:

ScheduledJobs_ListJobs

Get the list of jobs for a scheduled job definition.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Scheduled Job ID	scheduled_job_id	True	string	Unique ID of the scheduled job.

Returns

The paged results of job definitions belonging to a scheduled job.

Body

ScheduledJobJobCollection

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 ID	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 ID	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 ID	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 ID	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 ID	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 groups

Operation ID:

DeviceGroups_List

Get the list of device groups in an application.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.

Returns

The paged results of device groups.

Body

DeviceGroupCollection

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 jobs

Operation ID:

Jobs_List

Get the list of jobs in an application.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.

Returns

The paged results of jobs.

Body

JobCollection

List organizations

Operation ID:

Organizations_List

Get the list of organizations in an application.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.

Returns

Body

OrganizationCollection

List relationships

Operation ID:

DeviceRelationships_List

List all relationships based on device ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device ID	device_id	True	string	Unique ID of the device.

Returns

Body

DeviceRelationshipCollection

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 scheduled jobs

Operation ID:

ScheduledJobs_List

Get the list of scheduled jobs in an application.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.

Returns

The outputs of this operation are dynamic.

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

Resume a job on failed devices

Operation ID:

Jobs_Rerun

Execute a rerun of an existing job on all failed devices.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Job ID	job_id	True	string	Unique ID of the job.
Rerun ID	rerun_id	True	string	Unique ID of the rerun.

Returns

The job definition.

Body

JobStatic

Resume a stopped job

Operation ID:

Jobs_Resume

Resume execution of an existing stopped job.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Job ID	job_id	True	string	Unique ID of the job.

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 ID	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 ID	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 ID	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 ID	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.

Stop a running job

Operation ID:

Jobs_Stop

Stop execution of a job that is currently running.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Job ID	job_id	True	string	Unique ID of the job.

Update a device relationship

Operation ID:

DeviceRelationships_Update

Update an existing device relationship between the given device and a new device given a device ID and a relationship ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Device ID	device_id	True	string	Unique ID of the device.
Relationship ID	relationship_id	True	string	Unique ID of the device relationship.
Device Relationship ID	id		string	Unique ID of the device relationship.
Device Relationship Target ID	target	True	string	The device ID of the source (child) device.

Returns

Body

DeviceRelationshipStatic

Update a scheduled job

Operation ID:

ScheduledJobs_Update

Update an existing scheduled job by ID.

Parameters

Name	Key	Required	Type	Description
Application	application	True	string	Unique ID of the application.
Scheduled Job ID	scheduled_job_id	True	string	Unique ID of the scheduled job.
Schedule End Type	scheduled_job_end_type		string	How the scheduled job should end (not applied to device template migrations).
Body	body	True	dynamic	Scheduled Job create body.

Returns

The scheduled job definition.

Body

ScheduledJobStatic

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 ID	device_id	True	string	Unique ID of the device.
Device Template ID	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 ID	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 ID	device_id	True	string	Unique ID of the device.
Device Template ID	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 ID	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.

DeviceV2

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.
Organizations	organizations	array of string	List of organizations of the device, only one organization is supported today, multiple organizations will be supported soon.
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.

DeviceGroup

The device group definition.

Name	Path	Type	Description
Device Group ID	id	string	Unique ID of the device group.
Display Name	displayName	string	Display name of the device group.
Filter	filter	string	Query defining which devices should be in this group.
Description	description	string	Short summary of device group.
ETag	etag	string	ETag used to prevent conflict in device group updates.
Organizations	organizations	array of string	List of organizations of the device group, only one organization is supported today, multiple organizations will be supported soon.

DeviceGroupCollection

The paged results of device groups.

Name	Path	Type	Description
Device Group ID	value	array of DeviceGroup	The collection of device groups.
nextLink	nextLink	string	URL to get the next page of device groups.

DeviceGroupDeviceCollection

The paged results of devices belonging to the device group.

Name	Path	Type	Description
value	value	array of DeviceV1	The collection of devices belonging to the device group.
nextLink	nextLink	string	URL to get the next page of devices in the group.

DeviceRelationshipStatic

Name	Path	Type	Description
Device Relationship ID	id	string	Unique ID of the device relationship.
Device Relationship Source ID	source	string	The device ID of the source (parent) device.
Device Relationship Target ID	target	string	The device ID of the source (child) device.

DeviceRelationshipCollection

Name	Path	Type	Description
value	value	array of DeviceRelationshipStatic	The collection of device relationships.
nextLink	nextLink	string	URL to get the next page of device relationships.

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.

JobDeviceStatus

The job device status definition.

Name	Path	Type	Description
Device ID	id	string	ID of the device whose job status is being provided.
Device Status	status	string	Indicates whether the job is starting, running, etc. for the given device.

JobDeviceStatusCollection

The paged results of job device statuses.

Name	Path	Type	Description
value	value	array of JobDeviceStatus	The collection of job device statuses.
nextLink	nextLink	string	URL to get the next page of job device statuses.

JobBatch

The job batch definition.

Name	Path	Type	Description
Batch Type	type	string	Whether batching is done on a specified number of devices or a percentage of the total devices.
Batch Value	value	number	The number or percentage of devices on which batching is done.

JobCancellationThreshold

The job cancellation threshold definition.

Name	Path	Type	Description
Cancellation Threshold Type	type	string	Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices.
Cancellation Threshold Value	value	number	The number or percentage of devices on which the cancellation threshold is applied.
Cancellation Threshold Batch	batch	boolean	Whether the cancellation threshold applies per-batch or to the overall job.

JobStatic

The job definition.

Name	Path	Type	Description
Job ID	id	string	Unique ID of the job.
Display Name	displayName	string	Display name of the job.
Description	description	string	Detailed description of the job.
Device Group	group	string	The ID of the device group on which to execute the job.
batch	batch	JobBatch	The job batch definition.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	The job cancellation threshold definition.
Data	data	array of object	Data related to the operation being performed by this job. All entries must be of the same type.
items	data	object
Organizations	organizations	array of string	List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.
Scheduled Job ID	scheduledJobId	string	Id of the scheduled job definition that created this job.

JobCollection

The paged results of jobs.

Name	Path	Type	Description
value	value	array of JobStatic	The collection of jobs.
nextLink	nextLink	string	URL to get the next page of jobs.

Organization

Name	Path	Type	Description
Organization ID	id	string	Unique ID of the organization.
Organization Name	displayName	string	Display name of the organization.
Parent	parent	string	Display name of the parent organization.

OrganizationCollection

Name	Path	Type	Description
value	value	array of Organization	The collection of organizations.
nextLink	nextLink	string	URL to get the next page of organizations.

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.

ScheduledJobStatic

The scheduled job definition.

Name	Path	Type	Description
ETag	etag	string	ETag used to prevent conflict in scheduled job updates.
Scheduled Job ID	id	string	Unique ID of the scheduled job.
Display Name	displayName	string	Display name of the scheduled job.
Description	description	string	Detailed description of the scheduled job.
Device Group	group	string	The ID of the device group on which to execute the job.
batch	batch	JobBatch	The job batch definition.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	The job cancellation threshold definition.
Data	data	array of object	Data related to the operation being performed by this job. All entries must be of the same type.
items	data	object
Organizations	organizations	array of string	List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.
Schedule	schedule	object	The schedule at which to execute the job.
Enabled	enabled	boolean	Whether the scheduled job is enabled.
Completed	completed	boolean	Whether the scheduled job has completed.

ScheduledJobJobCollection

The paged results of job definitions belonging to a scheduled job.

Name	Path	Type	Description
value	value	array of JobStatic	The collection of jobs.
nextLink	nextLink	string	URL to get the next page of jobs.

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.