Share via

Image - List Images For Tenant

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

List images for the specified Azure Sphere Tenant ID.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/images
With optional parameters: 
GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/images?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

ImageMetadataItemCollectionResponse

Success.

Examples

List all images for the specified tenant

Sample request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/images

Sample response

Status code:
200 
{
  "Items": [
    {
      "Id": "583d37d2-dc16-441f-b927-933edd4c1085",
      "Name": "RefrigeratorRealTimeApp",
      "ComponentId": "005180bc-402f-4cb3-a662-72937dbcde47",
      "Description": null,
      "ImageType": 10,
      "Type": 10
    },
    {
      "Id": "a43206c8-f384-44a2-84ad-c86ce2937a3e",
      "Name": "RefrigeratorHighLevelApp",
      "ComponentId": "25025d2c-66da-4448-bae1-ac26fcdd3627",
      "Description": null,
      "ImageType": 10,
      "Type": 10
    },
    {
      "Id": "985453bb-eb5c-4ff2-8e06-aef4786ac445",
      "Name": "DishwasherHighLevelApp",
      "ComponentId": "45f4d635-1ac8-4fc3-b386-ffb74f13331f",
      "Description": null,
      "ImageType": 10,
      "Type": 10
    }
  ],
  "ContinuationToken": null
}

Definitions

Name Description
ImageMetadata
ImageMetadataItemCollectionResponse

ImageMetadata

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

Name Type Description
ContinuationToken

string

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

ImageMetadata[]

List of items.