Image - List Images For Tenant

Service:

Azure Sphere Public API

API Version:

v2

Вывод списка изображений для указанного идентификатора клиента 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

Имя	В	Обязательно	Тип	Описание
tenantId	path	True	string uuid	Идентификатор клиента Azure Sphere.
maxPageSize	query		integer int32	Максимальное количество результатов, которые должны быть включены в ответ.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Sphere-Continuation		string	Маркер продолжения, используемый для продолжения с предыдущей страницы результатов.

Ответы

Имя	Тип	Описание
200 OK	ImageMetadataItemCollectionResponse	Успешно.

Примеры

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
}

Определения

Имя	Описание
ImageMetadata
ImageMetadataItemCollectionResponse

ImageMetadata

Имя	Тип	Описание
ComponentId	string	Возвращает или задает идентификатор компонента.
Description	string	Возвращает или задает сведения, описывающие изображение.
Id	string	Возвращает или задает идентификатор изображения.
ImageType	integer	Это свойство использовать не рекомендуется. Используйте ImageMetadata.Type
Name	string	Возвращает или задает имя изображения.
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	Возвращает или задает тип изображения.

ImageMetadataItemCollectionResponse

Имя	Тип	Описание
ContinuationToken	string	Маркер продолжения, который можно использовать для получения следующего набора элементов.
Items	ImageMetadata[]	Список элементов.