Devices - List In Group

Service:

Azure Sphere Public API

API Version:

v2

Gets all devices that are assigned to specified DeviceGroup.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/{deviceGroupId}/devices

With optional parameters:

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/{deviceGroupId}/devices?maxPageSize={maxPageSize}

URI Parameters

Name	In	Required	Type	Description
deviceGroupId	path	True	string uuid	The DeviceGroup ID.
tenantId	path	True	string uuid	The Azure Sphere tenant ID.
maxPageSize	query		integer int32	The maximum number of results that should be included in the response.

Request Header

Name	Required	Type	Description
Sphere-Continuation		string	A continuation token used to continue from a previous page of results.

Responses

Name	Type	Description
200 OK	DeviceV2ItemCollectionResponse	Success.

Definitions

Name	Description
DeviceV2
DeviceV2ItemCollectionResponse

DeviceV2

Name	Type	Description
ChipSku	enum: 0 - MT3620AN	The ChipSku that this device supports
DeviceGroupId	string	Unique Id of DeviceGroup to which this device is assigned.The value will be null till device is assigned to a device group.
DeviceId	string	Unique id of the device.
LastAvailableOSVersion	string	The version of the OS that was available for installation on the device when the update was requested.
LastInstalledOSVersion	string	The version of the OS that was running on the device when the update was requested.
LastOSUpdateUTC	string	The Universal Time Coordinated (UTC) time when the call for an update was last requested and a new version of OS was available for installation.
LastUpdateRequestUTC	string	The Universal Time Coordinated (UTC) time when the call for an update was last requested by the device.
ProductId	string	Unique Id of product to which this device is assigned. The value will be null till device is assigned to a device group.
TenantId	string	Unique id of as3 tenant who owns this device. The value value be empty till device is claimed.

DeviceV2ItemCollectionResponse

Name	Type	Description
ContinuationToken	string	Continuation token that can be used to get next set of items.
Items	DeviceV2[]	List of items.