Image - Get Metadata

Service:

Azure Sphere Public API

API Version:

v2

Gets metadata for the specified Image.

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

URI Parameters

Name	In	Required	Type	Description
imageId	path	True	string uuid	The Image ID.
tenantId	path	True	string uuid	The Azure Sphere tenant ID.

Responses

Name	Type	Description
200 OK	ImageMetadata	Success.

Examples

Get an image's metadata

Sample Request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/images/985453bb-eb5c-4ff2-8e06-aef4786ac445/metadata

Sample Response

Status code:

200

{
  "Id": "985453bb-eb5c-4ff2-8e06-aef4786ac445",
  "Name": "DishwasherHighLevelApp",
  "ComponentId": "45f4d635-1ac8-4fc3-b386-ffb74f13331f",
  "Description": null,
  "ImageType": 10,
  "Type": 10
}

Definitions

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.