Share via

Device Group - Create

  • Reference
Service:
Azure Sphere Public API
API Version:
v2

Creates a DeviceGroup.

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

URI Parameters

Name In Required Type Description
tenantId
 path True

string

uuid

The Azure Sphere tenant ID.

Request Body

Name Type Description
Description

string

The description 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.
UpdatePolicy enum:
  • 0 - UpdateAll
  • 1 - No3rdPartyAppUpdates

The update policy that determines which software is updated.

Responses

Name Type Description
200 OK

DeviceGroupV2

Success.

Definitions

Name Description
Deployment
DeviceGroupV2
DeviceGroupV2CreateRequest

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.

DeviceGroupV2CreateRequest

Name Type Description
Description

string

The description 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.
UpdatePolicy enum:
  • 0 - UpdateAll
  • 1 - No3rdPartyAppUpdates

The update policy that determines which software is updated.