Share via

Deployments - Get By Device

Service:
Azure Sphere Public API
API Version:
v2

Get the list of images that should be installed on a given device.

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

URI Parameters

Name In Required Type Description
deviceId
 path True

string

The ID of the device for which deployed images are to be retrieved.
tenantId
 path True

string (uuid)

The Azure Sphere tenant ID.

Responses

Name Type Description
200 OK

ImageMetadataItemCollectionResponse

Success.

Definitions

Name Description
ImageMetadata
ImageMetadataItemCollectionResponse

ImageMetadata

Object
Name Type Description
ComponentId

string

Gets or sets the component identifier.
Description

string

Gets or sets the information describing the image.
Id

string

Gets or sets the image identifier.
ImageType

integer

This property is deprecated. Please use ImageMetadata.Type
Name

string

Gets or sets the name of the image.
Type enum:
  • 0 - InvalidImageType
  • 1 - OneBl
  • 10 - Applications
  • 13 - FwConfig
  • 16 - BootManifest
  • 17 - Nwfs
  • 19 - TrustedKeystore
  • 2 - PlutonRuntime
  • 20 - Policy
  • 21 - CustomerBoardConfig
  • 22 - UpdateCertStore
  • 23 - BaseSystemUpdateManifest
  • 24 - FirmwareUpdateManifest
  • 25 - CustomerUpdateManifest
  • 26 - RecoveryManifest
  • 27 - ManifestSet
  • 28 - Other
  • 3 - WifiFirmware
  • 4 - SecurityMonitor
  • 5 - NormalWorldLoader
  • 6 - NormalWorldDtb
  • 7 - NormalWorldKernel
  • 8 - RootFs
  • 9 - Services

Gets or sets the image's type.

ImageMetadataItemCollectionResponse

Object
Name Type Description
ContinuationToken

string

Continuation token that can be used to get next set of items.
Items

ImageMetadata[]

List of items.