Image - List Images For Tenant

Service:

Azure Sphere Public API

API Version:

v2

Visa en lista över avbildningar för det angivna Klient-ID:t för Azure Sphere.

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-parametrar

Name	I	Obligatorisk	Typ	Description
tenantId	path	True	string uuid	Klient-ID:t för Azure Sphere.
maxPageSize	query		integer int32	Det maximala antalet resultat som ska ingå i svaret.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Sphere-Continuation		string	En fortsättningstoken som används för att fortsätta från en föregående sida med resultat.

Svar

Name	Typ	Description
200 OK	ImageMetadataItemCollectionResponse	Åtgärden lyckades.

Exempel

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
}

Definitioner

Name	Description
ImageMetadata
ImageMetadataItemCollectionResponse

ImageMetadata

Name	Typ	Description
ComponentId	string	Hämtar eller anger komponentidentifieraren.
Description	string	Hämtar eller anger den information som beskriver bilden.
Id	string	Hämtar eller anger bildidentifieraren.
ImageType	integer	Den här egenskapen är inaktuell. Använd ImageMetadata.Type
Name	string	Hämtar eller anger namnet på bilden.
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	Hämtar eller anger avbildningens typ.

ImageMetadataItemCollectionResponse

Name	Typ	Description
ContinuationToken	string	Fortsättningstoken som kan användas för att hämta nästa uppsättning objekt.
Items	ImageMetadata[]	Lista över objekt.