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.
- 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.
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.
- 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
, andGet 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
andUpdate device cloud properties
are now part ofGet device properties
andUpdate 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.
- 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.
- 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.
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 |
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.
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.
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
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 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 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
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
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
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 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 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 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 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
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 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 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 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 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 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 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 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 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
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 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 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 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 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 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
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 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
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
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
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
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
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
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
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.
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
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
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.
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.
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
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
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
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
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
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 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
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.
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
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
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
Get the list of organizations in an application.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Application
|
application | True | string |
Unique ID of the application. |
Returns
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
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
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
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
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 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 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
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
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
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
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 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
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 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
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
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
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
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
When a rule is fired |
Create an action which triggers when a rule is fired in IoT Central. |
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
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. |
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. |
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. |
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of DeviceV1 |
The collection of devices. |
nextLink
|
nextLink | string |
URL to get the next page of devices. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of Organization |
The collection of organizations. |
nextLink
|
nextLink | string |
URL to get the next page of organizations. |
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
Unique ID of the role. |
displayName
|
displayName | string |
Display name of the role. |
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of RoleV1 |
The collection of roles. |
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. |
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. |
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. |
Name | Path | Type | Description |
---|---|---|---|
Users
|
value | array of UserStaticV1 |
The collection of users. |
Name | Path | Type | Description |
---|---|---|---|
Role
|
role | string |
ID of the role for this role assignment. |