Device Group - Get In Product

Service:

Azure Sphere Public API

API Version:

v2

Gets the DeviceGroup with the specified name within the Product with the specified name.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products/name/{productName}/deviceGroups/name/{deviceGroupName}

URI Parameters

Name	In	Required	Type	Description
deviceGroupName	path	True	string	The name of the DeviceGroup.
productName	path	True	string	The name of the Product under which the device groups exists.
tenantId	path	True	string uuid	The Azure Sphere tenant ID.

Responses

Name	Type	Description
200 OK	DeviceGroupV2	Success.

Examples

Get device group in product

Sample request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/products/name/Dishwasher/deviceGroups/name/US region

Sample response

Status code:

200

{
  "Id": "c4b1067f-10be-479a-85e9-d062dae189e1",
  "TenantId": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
  "OsFeedType": 0,
  "ProductId": "b0ba65bc-648f-4213-a910-cbeb6024c744",
  "Name": "US region",
  "Description": "United States marketing region",
  "CurrentDeployment": null,
  "UpdatePolicy": 0,
  "AllowCrashDumpsCollection": false
}

Definitions

Name	Description
Deployment
DeviceGroupV2

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.