Partager via

Image - List Images For Tenant

  • Référence
Service:
Azure Sphere Public API
API Version:
v2

Répertorier les images pour l’ID de locataire Azure Sphere spécifié.

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}

Paramètres URI

Nom Dans Obligatoire Type Description
tenantId
 path True

string

uuid

ID de locataire Azure Sphere.
maxPageSize
 query

integer

int32

Nombre maximal de résultats à inclure dans la réponse.

En-tête de la demande

Nom Obligatoire Type Description
Sphere-Continuation

string

Jeton de continuation utilisé pour continuer à partir d’une page de résultats précédente.

Réponses

Nom Type Description
200 OK

ImageMetadataItemCollectionResponse

Opération réussie.

Exemples

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
}

Définitions

Nom Description
ImageMetadata
ImageMetadataItemCollectionResponse

ImageMetadata

Nom Type Description
ComponentId

string

Obtient ou définit l’identificateur du composant.
Description

string

Obtient ou définit les informations décrivant l’image.
Id

string

Obtient ou définit l’identificateur d’image.
ImageType

integer

Cette propriété est déconseillée. Utilisez ImageMetadata.Type
Name

string

Obtient ou définit le nom de l’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

Obtient ou définit le type de l’image.

ImageMetadataItemCollectionResponse

Nom Type Description
ContinuationToken

string

Jeton de continuation qui peut être utilisé pour obtenir l’ensemble d’éléments suivant.
Items

ImageMetadata[]

Liste d’éléments.