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 參數

名稱	位於	必要	類型	Description
tenantId	path	True	string uuid	Azure Sphere 租使用者識別碼。
maxPageSize	query		integer int32	回應中應包含的結果數目上限。

要求標頭

名稱	必要	類型	Description
Sphere-Continuation		string	用來繼續上一頁結果的接續權杖。

回應

名稱	類型	Description
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
}

定義

名稱	Description
ImageMetadata
ImageMetadataItemCollectionResponse

ImageMetadata

名稱	類型	Description
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

名稱	類型	Description
ContinuationToken	string	可用來取得下一組專案的接續權杖。
Items	ImageMetadata[]	專案清單。