Device Group - Patch

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

Patches a DeviceGroup.

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

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.

Request Body

Name Type Description
AllowCrashDumpsCollection

boolean

Enables crash dumps collection for a given device group
Description

string

The description of the device group.
Name

string

The name of the device group.
OSFeedType enum:
  • 0 - Retail
  • 1 - RetailEval

The unique ID of the osfeed type that this device group uses for OS updates.
UpdatePolicy enum:
  • 0 - UpdateAll
  • 1 - No3rdPartyAppUpdates

The update policy that determines which software is updated

Responses

Name Type Description
200 OK

DeviceGroupV2

The patched DeviceGroup object.
400 Bad Request

PublicApiErrorDetails[]

Bad Request
404 Not Found

PublicApiErrorDetails[]

Not Found
500 Internal Server Error

PublicApiErrorDetails[]

Server Error

Definitions

Name Description
Deployment
DeviceGroupV2
DeviceGroupV2PatchRequest
PublicApiErrorDetails

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.

DeviceGroupV2PatchRequest

Name Type Description
AllowCrashDumpsCollection

boolean

Enables crash dumps collection for a given device group
Description

string

The description of the device group.
Name

string

The name of the device group.
OSFeedType enum:
  • 0 - Retail
  • 1 - RetailEval

The unique ID of the osfeed type that this device group uses for OS updates.
UpdatePolicy enum:
  • 0 - UpdateAll
  • 1 - No3rdPartyAppUpdates

The update policy that determines which software is updated

PublicApiErrorDetails

Name Type Description
Detail

string

A human-readable explanation specific to this occurrence of the problem.
ErrorCode

string

A string representation of PublicApiErrorCode defining the error.
Extensions

Gets the Dictionary for extension members.Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type.
Instance

string

A URI reference that identifies the specific occurrence of the problem.It mayor may not yield further information if dereferenced.
Status

integer

The HTTP status code([RFC7231], Section 6) generated by the origin server forthis occurrence of the problem.
Title

string

A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g.,using proactive content negotiation; see[RFC7231], Section 3.4).
Type

string

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be blank.