Azure IoT Central (preview:preview)

2025/10/23 • 71 new methods

ApiTokens_List (new)
Description :  Get the list of API tokens in an application. The token value will never be returned for security reasons.
Reference :  Link ¶

⚼ Request

GET:  /apiTokens
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of API tokens. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of API tokens. ,
Required: False ,
}
string ,
}
ApiTokens_Get (new)
Description :  Get an API token by ID.
Reference :  Link ¶

⚼ Request

GET:  /apiTokens/{tokenId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
tokenId:
{
Description: Unique ID for the API token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
ApiTokens_Create (new)
Description :  Create a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.
Reference :  Link ¶

⚼ Request

PUT:  /apiTokens/{tokenId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
tokenId:
{
Description: Unique ID for the API token. ,
Required: True ,
}
string ,
body:
{
Description: API token body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the API token. ,
Required: False ,
}
string ,
token:
{
Description: Value of the API token. ,
Required: False ,
}
string ,
expiry:
{
Description: String-formatted date representing the time when the token expires. ,
Format: date-time ,
Required: False ,
}
string ,
}
ApiTokens_Remove (new)
Description :  Delete an API token.
Reference :  Link ¶

⚼ Request

DELETE:  /apiTokens/{tokenId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
tokenId:
{
Description: Unique ID for the API token. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
ContinuousDataExports_List (new)
Description :  Get the list of continuous data exports in an application.
Reference :  Link ¶

⚼ Request

GET:  /continuousDataExports
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of continuous data exports. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the continuous data export. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in continuous data export updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the continuous data export. ,
Required: False ,
}
string ,
endpoint:
{
Description: Location where exported data should be sent. ,
Required: True ,
}
{
type:
{
Description: Type of the endpoint. ,
Required: True ,
}
string ,
connectionString:
{
Description: Information for connecting to the endpoint. ,
Required: True ,
}
string ,
name:
{
Description: Name of the entity to send data to. ,
Required: True ,
}
string ,
}
,
status:
{
Description: Indicates whether the continuous data export is starting, running, etc. ,
Required: False ,
}
string ,
enabled:
{
Description: Boolean indicating whether the continuous data export should be running or not. ,
Required: True ,
}
boolean ,
sources:
{
Description: Data sources to export to the endpoint. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next page of continuous data exports. ,
Required: False ,
}
string ,
}
ContinuousDataExports_Get (new)
Description :  Get a continuous data export by ID.
Reference :  Link ¶

⚼ Request

GET:  /continuousDataExports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the continuous data export. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the continuous data export. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in continuous data export updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the continuous data export. ,
Required: False ,
}
string ,
endpoint:
{
Description: Location where exported data should be sent. ,
Required: True ,
}
{
type:
{
Description: Type of the endpoint. ,
Required: True ,
}
string ,
connectionString:
{
Description: Information for connecting to the endpoint. ,
Required: True ,
}
string ,
name:
{
Description: Name of the entity to send data to. ,
Required: True ,
}
string ,
}
,
status:
{
Description: Indicates whether the continuous data export is starting, running, etc. ,
Required: False ,
}
string ,
enabled:
{
Description: Boolean indicating whether the continuous data export should be running or not. ,
Required: True ,
}
boolean ,
sources:
{
Description: Data sources to export to the endpoint. ,
Required: True ,
}
[
string ,
]
,
}
ContinuousDataExports_Create (new)
Description :  Create a new continuous data export.
Reference :  Link ¶

⚼ Request

PUT:  /continuousDataExports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the continuous data export. ,
Required: True ,
}
string ,
body:
{
Description: Data export body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the continuous data export. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in continuous data export updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the continuous data export. ,
Required: False ,
}
string ,
endpoint:
{
Description: Location where exported data should be sent. ,
Required: True ,
}
{
type:
{
Description: Type of the endpoint. ,
Required: True ,
}
string ,
connectionString:
{
Description: Information for connecting to the endpoint. ,
Required: True ,
}
string ,
name:
{
Description: Name of the entity to send data to. ,
Required: True ,
}
string ,
}
,
status:
{
Description: Indicates whether the continuous data export is starting, running, etc. ,
Required: False ,
}
string ,
enabled:
{
Description: Boolean indicating whether the continuous data export should be running or not. ,
Required: True ,
}
boolean ,
sources:
{
Description: Data sources to export to the endpoint. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the continuous data export. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in continuous data export updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the continuous data export. ,
Required: False ,
}
string ,
endpoint:
{
Description: Location where exported data should be sent. ,
Required: True ,
}
{
type:
{
Description: Type of the endpoint. ,
Required: True ,
}
string ,
connectionString:
{
Description: Information for connecting to the endpoint. ,
Required: True ,
}
string ,
name:
{
Description: Name of the entity to send data to. ,
Required: True ,
}
string ,
}
,
status:
{
Description: Indicates whether the continuous data export is starting, running, etc. ,
Required: False ,
}
string ,
enabled:
{
Description: Boolean indicating whether the continuous data export should be running or not. ,
Required: True ,
}
boolean ,
sources:
{
Description: Data sources to export to the endpoint. ,
Required: True ,
}
[
string ,
]
,
}
ContinuousDataExports_Update (new)
Description :  Update an existing continuous data export via patch.
Reference :  Link ¶

⚼ Request

PATCH:  /continuousDataExports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the continuous data export. ,
Required: True ,
}
string ,
body:
{
Description: Data export patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the continuous data export. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in continuous data export updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the continuous data export. ,
Required: False ,
}
string ,
endpoint:
{
Description: Location where exported data should be sent. ,
Required: True ,
}
{
type:
{
Description: Type of the endpoint. ,
Required: True ,
}
string ,
connectionString:
{
Description: Information for connecting to the endpoint. ,
Required: True ,
}
string ,
name:
{
Description: Name of the entity to send data to. ,
Required: True ,
}
string ,
}
,
status:
{
Description: Indicates whether the continuous data export is starting, running, etc. ,
Required: False ,
}
string ,
enabled:
{
Description: Boolean indicating whether the continuous data export should be running or not. ,
Required: True ,
}
boolean ,
sources:
{
Description: Data sources to export to the endpoint. ,
Required: True ,
}
[
string ,
]
,
}
ContinuousDataExports_Remove (new)
Description :  Delete a continuous data export.
Reference :  Link ¶

⚼ Request

DELETE:  /continuousDataExports/{exportId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
exportId:
{
Description: Unique ID for the continuous data export. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
DeviceGroups_List (new)
Description :  Get the list of device groups in an application.
Reference :  Link ¶

⚼ Request

GET:  /deviceGroups
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device groups. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device group. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device groups. ,
Required: False ,
}
string ,
}
DeviceTemplates_List (new)
Description :  Get the list of device templates in an application
Reference :  Link ¶

⚼ Request

GET:  /deviceTemplates
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device templates. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
types:
{
Description: The types of device to which this template applies. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
solutionModel:
{
Description: The solution model utilized by this device template. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device templates. ,
Required: False ,
}
string ,
}
DeviceTemplates_Get (new)
Description :  Get a device template by ID
Reference :  Link ¶

⚼ Request

GET:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique ID of the device template. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
types:
{
Description: The types of device to which this template applies. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
solutionModel:
{
Description: The solution model utilized by this device template. ,
Required: False ,
}
object ,
}
DeviceTemplates_Create (new)
Description :  Publish a new device template. Default views will be automatically generated for new device templates created this way.
Reference :  Link ¶

⚼ Request

PUT:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique ID of the device template. ,
Required: True ,
}
string ,
body:
{
Description: Device template body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
types:
{
Description: The types of device to which this template applies. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
solutionModel:
{
Description: The solution model utilized by this device template. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
types:
{
Description: The types of device to which this template applies. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
solutionModel:
{
Description: The solution model utilized by this device template. ,
Required: False ,
}
object ,
}
DeviceTemplates_Update (new)
Description :  Update the cloud properties and overrides of an existing device template via patch.
Reference :  Link ¶

⚼ Request

PATCH:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique ID of the device template. ,
Required: True ,
}
string ,
body:
{
Description: Device template patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
types:
{
Description: The types of device to which this template applies. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
solutionModel:
{
Description: The solution model utilized by this device template. ,
Required: False ,
}
object ,
}
DeviceTemplates_Remove (new)
Description :  Delete an existing device template by device ID.
Reference :  Link ¶

⚼ Request

DELETE:  /deviceTemplates/{deviceTemplateId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique ID of the device template. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
DeviceTemplates_ListDevices (new)
Description :  Get devices for a template
Reference :  Link ¶

⚼ Request

GET:  /deviceTemplates/{deviceTemplateId}/devices
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique ID of the device template. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of devices. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
instanceOf:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
approved:
{
Description: Whether the device has been approved to connect to IoT Central. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of devices. ,
Required: False ,
}
string ,
}
DeviceTemplates_GetMerged (new)
Description :  Get a merged device template by ID
Reference :  Link ¶

⚼ Request

GET:  /deviceTemplates/{deviceTemplateId}/merged
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceTemplateId:
{
Description: Unique ID of the device template. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device template. ,
Required: False ,
}
string ,
types:
{
Description: The types of device to which this template applies. ,
Required: True ,
}
[
string ,
]
,
etag:
{
Description: ETag used to prevent conflict in device template updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device template. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the device template. ,
Required: False ,
}
string ,
capabilityModel:
{
Description: The capability model utilized by this device template. ,
Required: True ,
}
object ,
solutionModel:
{
Description: The solution model utilized by this device template. ,
Required: False ,
}
object ,
}
Devices_List (new)
Description :  Get the list of devices in an application
Reference :  Link ¶

⚼ Request

GET:  /devices
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of devices. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
instanceOf:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
approved:
{
Description: Whether the device has been approved to connect to IoT Central. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of devices. ,
Required: False ,
}
string ,
}
Devices_Get (new)
Description :  Get details about an existing device by device ID.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
instanceOf:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
approved:
{
Description: Whether the device has been approved to connect to IoT Central. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
}
Devices_Create (new)
Description :  Create a new device.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
instanceOf:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
approved:
{
Description: Whether the device has been approved to connect to IoT Central. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
instanceOf:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
approved:
{
Description: Whether the device has been approved to connect to IoT Central. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
}
Devices_Update (new)
Description :  Update an existing device by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the device. ,
Required: False ,
}
string ,
etag:
{
Description: ETag used to prevent conflict in device updates. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the device. ,
Required: False ,
}
string ,
instanceOf:
{
Description: The device template definition for the device. ,
Required: False ,
}
string ,
approved:
{
Description: Whether the device has been approved to connect to IoT Central. ,
Required: False ,
}
boolean ,
provisioned:
{
Description: Whether resources have been allocated for the device. ,
Required: False ,
}
boolean ,
simulated:
{
Description: Whether the device is simulated. ,
Required: False ,
}
boolean ,
}
Devices_Remove (new)
Description :  Delete an existing device by device ID.
Reference :  Link ¶

⚼ Request

DELETE:  /devices/{deviceId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Devices_GetAttestation (new)
Description :  Get device attestation
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
Devices_CreateAttestation (new)
Description :  Create an individual device attestation
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Individual device attestation body. ,
Required: True ,
}
{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
Devices_UpdateAttestation (new)
Description :  Update an individual device attestation via patch
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Individual device attestation patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
type:
{
Description: Type of the attestation. ,
Required: True ,
}
string ,
}
Devices_RemoveAttestation (new)
Description :  Remove an individual device attestation
Reference :  Link ¶

⚼ Request

DELETE:  /devices/{deviceId}/attestation
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Devices_GetCloudProperties (new)
Description :  Get all cloud property values of a device by device ID.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/cloudProperties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Cloud property values associated with the device. ,
}
object ,
}
Devices_ReplaceCloudProperties (new)
Description :  Update all cloud property values of a device by device ID.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/cloudProperties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device properties. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Cloud property values associated with the device. ,
}
object ,
}
Devices_UpdateCloudProperties (new)
Description :  Update cloud property values of a device by device ID.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/cloudProperties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
$schema:
{
Description: Cloud property values associated with the device. ,
}
object ,
}
Devices_GetCommandHistory (new)
Description :  Get device command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}
Devices_RunCommand (new)
Description :  Run a command on a device.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
Devices_ListComponents (new)
Description :  List the components present in a device
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of entities. ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: URL to get the next page of entities. ,
Required: False ,
}
string ,
}
Devices_GetComponentCommandHistory (new)
Description :  Get component command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}
Devices_RunComponentCommand (new)
Description :  Run a command on a component.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
Devices_GetComponentProperties (new)
Description :  Get device properties for a specific component
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_ReplaceComponentProperties (new)
Description :  Replace device properties for a specific component
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Device properties. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_UpdateComponentProperties (new)
Description :  Update device properties for a specific component via patch
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Device properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_GetComponentTelemetryValue (new)
Description :  Get the last telemetry value from a component.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/components/{componentName}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}
Devices_GetCredentials (new)
Description :  Get device credentials
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/credentials
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
idScope:
{
Description: ID scope for connecting to the IoT Central application. ,
Required: True ,
}
string ,
symmetricKey:
{
Description: The symmetric key credentials for the device. ,
Required: False ,
}
{
primaryKey:
{
Description: The primary key for this credential. ,
Required: True ,
}
string ,
secondaryKey:
{
Description: The secondary key for this credential. ,
Required: True ,
}
string ,
}
,
x509:
{
Description: The X.509 credential information for the device. ,
Required: False ,
}
{
clientCertificates:
{
Description: The X.509 client certificates for this credential. ,
Required: False ,
}
{
primary:
{
Description: The primary X.509 certificate for this credential. ,
Required: True ,
}
{
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
secondary:
{
Description: The secondary X.509 certificate for this credential. ,
Required: False ,
}
{
certificate:
{
Description: The string representation of this certificate. ,
Required: False ,
}
string ,
info:
{
Description: Information about this certificate. ,
Required: False ,
}
{
sha1Thumbprint:
{
Description: The SHA-1 hash value of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
}
,
}
,
tpm:
{
Description: The TPM credentials for the device. ,
Required: False ,
}
{
endorsementKey:
{
Description: The TPM endorsement key for this credential. ,
Required: True ,
}
string ,
}
,
}
Devices_ListModules (new)
Description :  List the modules present in a device
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of entities. ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: URL to get the next page of entities. ,
Required: False ,
}
string ,
}
Devices_GetModuleCommandHistory (new)
Description :  Get module command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}
Devices_RunModuleCommand (new)
Description :  Run a command on a module.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/modules/{moduleName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
Devices_ListModuleComponents (new)
Description :  List the components present in a module
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of entities. ,
Required: True ,
}
[
object ,
]
,
nextLink:
{
Description: URL to get the next page of entities. ,
Required: False ,
}
string ,
}
Devices_GetModuleComponentCommandHistory (new)
Description :  Get module component command history
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of device command executions. ,
Required: True ,
}
[
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of device command executions. ,
Required: False ,
}
string ,
}
Devices_RunModuleComponentCommand (new)
Description :  Run a command on a module.
Reference :  Link ¶

⚼ Request

POST:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
commandName:
{
Description: Name of this device command. ,
Required: True ,
}
string ,
body:
{
Description: Device command body. ,
Required: True ,
}
{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The request ID of the device command execution. ,
Required: False ,
}
string ,
connectionTimeout:
{
Description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds. ,
Required: False ,
}
integer ,
responseTimeout:
{
Description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds. ,
Required: False ,
}
integer ,
request:
{
Description: The payload for the device command. ,
Required: False ,
}
string ,
response:
{
Description: The payload of the device command response. ,
Required: False ,
}
string ,
responseCode:
{
Description: The status code of the device command response. ,
Required: False ,
}
integer ,
}
Devices_GetModuleComponentProperties (new)
Description :  Get module properties for a specific component
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_ReplaceModuleComponentProperties (new)
Description :  Replace module properties for a specific component
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Module properties. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_UpdateModuleComponentProperties (new)
Description :  Update module properties for a specific component via patch
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
body:
{
Description: Module properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_GetModuleComponentTelemetryValue (new)
Description :  Get the last telemetry value from a module component.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
componentName:
{
Description: Name of the device component. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}
Devices_GetModuleProperties (new)
Description :  Get all property values of a module.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_ReplaceModuleProperties (new)
Description :  Replace all property values of a module.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/modules/{moduleName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
body:
{
Description: Module properties. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_UpdateModuleProperties (new)
Description :  Update property values of a module.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/modules/{moduleName}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
body:
{
Description: Module properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_GetModuleTelemetryValue (new)
Description :  Get the last telemetry value from a module.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/modules/{moduleName}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
moduleName:
{
Description: Name of the device module. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}
Devices_GetProperties (new)
Description :  Get all property values of a device by device ID.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_ReplaceProperties (new)
Description :  Replace all property values of a device by device ID.
Reference :  Link ¶

⚼ Request

PUT:  /devices/{deviceId}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device properties. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_UpdateProperties (new)
Description :  Update property values of a device by device ID.
Reference :  Link ¶

⚼ Request

PATCH:  /devices/{deviceId}/properties
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
body:
{
Description: Device properties patch. ,
Required: True ,
}
object ,
}

⚐ Response (202)

{
$schema:
{
Description: Property values associated with the device. ,
}
object ,
}
Devices_GetTelemetryValue (new)
Description :  Get the last telemetry value from a device.
Reference :  Link ¶

⚼ Request

GET:  /devices/{deviceId}/telemetry/{telemetryName}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
deviceId:
{
Description: Unique ID of the device. ,
Required: True ,
}
string ,
telemetryName:
{
Description: Name of this device telemetry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The last known value of this device telemetry. ,
Required: False ,
}
string ,
timestamp:
{
Description: String-formatted date representing the time when the telemetry value was sent. ,
Format: date-time ,
Required: False ,
}
string ,
}
Jobs_List (new)
Description :  Get the list of jobs in an application
Reference :  Link ¶

⚼ Request

GET:  /jobs
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of jobs. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
target:
{
Description: The device template which defines the target capability for the job. ,
Required: True ,
}
string ,
path:
{
Description: The path to the target capability within the device template. ,
Required: True ,
}
string ,
value:
{
Description: The value used to update the target capability, if any. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of jobs. ,
Required: False ,
}
string ,
}
Jobs_Get (new)
Description :  Get details about a running or completed job by job ID.
Reference :  Link ¶

⚼ Request

GET:  /jobs/{jobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
target:
{
Description: The device template which defines the target capability for the job. ,
Required: True ,
}
string ,
path:
{
Description: The path to the target capability within the device template. ,
Required: True ,
}
string ,
value:
{
Description: The value used to update the target capability, if any. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
}
Jobs_Create (new)
Description :  Create and execute a new job via its job definition.
Reference :  Link ¶

⚼ Request

PUT:  /jobs/{jobId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
body:
{
Description: Job definition. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
target:
{
Description: The device template which defines the target capability for the job. ,
Required: True ,
}
string ,
path:
{
Description: The path to the target capability within the device template. ,
Required: True ,
}
string ,
value:
{
Description: The value used to update the target capability, if any. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
target:
{
Description: The device template which defines the target capability for the job. ,
Required: True ,
}
string ,
path:
{
Description: The path to the target capability within the device template. ,
Required: True ,
}
string ,
value:
{
Description: The value used to update the target capability, if any. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
}
Jobs_GetDevices (new)
Description :  Get the list of individual device statuses by job ID.
Reference :  Link ¶

⚼ Request

GET:  /jobs/{jobId}/devices
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of job device statuses. ,
Required: True ,
}
[
{
id:
{
Description: ID of the device whose job status is being provided. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the job is starting, running, etc. for the given device. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of job device statuses. ,
Required: False ,
}
string ,
}
Jobs_Rerun (new)
Description :  Execute a rerun of an existing job on all failed devices.
Reference :  Link ¶

⚼ Request

PUT:  /jobs/{jobId}/rerun/{rerunId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
rerunId:
{
Description: Unique ID of the job rerun. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the job. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the job. ,
Required: False ,
}
string ,
description:
{
Description: Detailed description of the job. ,
Required: False ,
}
string ,
group:
{
Description: The ID of the device group on which to execute the job. ,
Required: True ,
}
string ,
batch:
{
Description: The batching configuration for the job. ,
Required: False ,
}
{
type:
{
Description: Whether batching is done on a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which batching is done. ,
Required: True ,
}
number ,
}
,
cancellationThreshold:
{
Description: The cancellation threshold for the job. ,
Required: False ,
}
{
type:
{
Description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. ,
Enum:
{
number: No description available. ,
percentage: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The number or percentage of devices on which the cancellation threshold is applied. ,
Required: True ,
}
number ,
batch:
{
Description: Whether the cancellation threshold applies per-batch or to the overall job. ,
Required: False ,
}
boolean ,
}
,
data:
{
Description: The capabilities being updated by the job and the values with which they are being updated. ,
Required: True ,
}
[
{
type:
{
Description: Type of the job data. ,
Required: True ,
}
string ,
target:
{
Description: The device template which defines the target capability for the job. ,
Required: True ,
}
string ,
path:
{
Description: The path to the target capability within the device template. ,
Required: True ,
}
string ,
value:
{
Description: The value used to update the target capability, if any. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Indicates whether the job is starting, running, etc. ,
Required: False ,
}
string ,
}
Jobs_Resume (new)
Description :  Resume execution of an existing stopped job.
Reference :  Link ¶

⚼ Request

POST:  /jobs/{jobId}/resume
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Jobs_Stop (new)
Description :  Stop execution of a job that is currently running.
Reference :  Link ¶

⚼ Request

POST:  /jobs/{jobId}/stop
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
jobId:
{
Description: Unique ID of the job. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Roles_List (new)
Description :  Get the list of roles in an application.
Reference :  Link ¶

⚼ Request

GET:  /roles
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of roles. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the role. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the role. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of roles. ,
Required: False ,
}
string ,
}
Roles_Get (new)
Description :  Get a role by ID.
Reference :  Link ¶

⚼ Request

GET:  /roles/{roleId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
roleId:
{
Description: Unique ID for the role. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the role. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the role. ,
Required: False ,
}
string ,
}
Users_List (new)
Description :  Get the list of users in an application
Reference :  Link ¶

⚼ Request

GET:  /users
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of users. ,
Required: True ,
}
[
{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next page of users. ,
Required: False ,
}
string ,
}
Users_Get (new)
Description :  Get a user by ID
Reference :  Link ¶

⚼ Request

GET:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID of the user. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
Users_Create (new)
Description :  Create a user in the application
Reference :  Link ¶

⚼ Request

PUT:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID of the user. ,
Required: True ,
}
string ,
body:
{
Description: User body. ,
Required: True ,
}
{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
Users_Update (new)
Description :  Update a user in the application via patch
Reference :  Link ¶

⚼ Request

PATCH:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID of the user. ,
Required: True ,
}
string ,
body:
{
Description: User patch body. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
id:
{
Description: Unique ID of the user. ,
Required: False ,
}
string ,
type:
{
Description: Type of the user. ,
Required: True ,
}
string ,
}
Users_Remove (new)
Description :  Delete a user
Reference :  Link ¶

⚼ Request

DELETE:  /users/{userId}
{
api-version:
{
Description: The version of the API being called. ,
Required: True ,
}
string ,
userId:
{
Description: Unique ID of the user. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}