Device Group - List

Service:

Azure Sphere Public API

API Version:

v2

Gets all DeviceGroups.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
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	DeviceGroupV2ItemCollectionResponse	Success.

Definitions

Name	Description
Deployment
DeviceGroupV2
DeviceGroupV2ItemCollectionResponse

Deployment

Name	Type	Description
DeployedImages	string[]	The IDs of images that are currently in this deployment.
DeploymentDateUtc	string	The DateTime that the deployment was created.
Id	string	The unique ID of the deployment.
TenantId	string	The unique ID of the tenant that owns the deployment.

DeviceGroupV2

Name	Type	Description
AllowCrashDumpsCollection	boolean	Enables crash dumps collection for a given device group
CurrentDeployment	Deployment
Description	string	The description of the device group.
Id	string	The unique ID of the device group.
Name	string	The name of the device group.
OsFeedType	enum: 0 - Retail 1 - RetailEval	The osfeed type that this device group uses for OS updates.
ProductId	string	The unique ID of the product that this device group belongs to.
TenantId	string	The unique ID of the tenant that owns the device group.
UpdatePolicy	enum: 0 - UpdateAll 1 - No3rdPartyAppUpdates	The update policy that determines which software is updated.

DeviceGroupV2ItemCollectionResponse

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