Device Update - List Updates

Szolgáltatás:: Device Update

API-verzió:: 2022-10-01

Szerezze be az IoT Hub eszközfrissítésbe importált összes frissítés listáját.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01

Opcionális paraméterekkel:

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (url)	Az IoT Hub-fiók végpontjának eszközfrissítése (csak gazdagépnév, protokoll nélkül).
instanceId	path	True	string	Az IoT Hub-fiókpéldány-azonosító eszközfrissítése.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.
filter	query		string	Nem kötelező szűrni a frissítéseket az isDeployable tulajdonság alapján.
search	query		string	Ingyenes szöveges keresési kifejezésnek megfelelő frissítések kérése.

Válaszok

Name	Típus	Description
200 OK	UpdateList	Az összes importált frissítés vagy üres lista, ha nincs.
Other Status Codes	ErrorResponse	Alapértelmezett válasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://api.adu.microsoft.com/.default	Alapértelmezett engedélyezési hatókör.

Példák

DeviceUpdate_ListUpdates

Mintakérelem

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates?api-version=2022-10-01

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "compatibility": [
        {
          "deviceManufacturer": "Microsoft",
          "deviceModel": "Toaster"
        }
      ],
      "instructions": {
        "steps": [
          {
            "description": "pre-install script",
            "handler": "microsoft/script:1",
            "handlerProperties": {
              "arguments": "--pre-install"
            },
            "files": [
              "configure.sh"
            ]
          },
          {
            "type": "reference",
            "updateId": {
              "provider": "microsoft",
              "name": "sensor",
              "version": "1.0"
            }
          }
        ]
      },
      "manifestVersion": "5.0",
      "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
      "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
      "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
    }
  ]
}

Definíciók

Name	Description
Error	Hiba részletei.
ErrorResponse	Gyakori hibaválasz.
InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
Instructions
Step	A telepítési utasítás lépésének frissítése.
StepType	Lépés típusa.
Update	Metaadatok frissítése.
UpdateId	Frissítésazonosító.
UpdateList	A frissítések listája.

Error

Objektum

Hiba részletei.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakód.
details	Error[]	Hibatömb, amely a jelentett hibához vezetett.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
occurredDateTime	string (date-time)	A hiba bekövetkezésének dátuma és időpontja (UTC).
target	string	A hiba célja.

ErrorResponse

Objektum

Gyakori hibaválasz.

Name	Típus	Description
error	Error	A hiba részletei.

InnerError

Objektum

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a hiba tartalmazott.
errorDetail	string	A belső hiba vagy kivétel üzenete.
innerError	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.

Instructions

Objektum

Name	Típus	Description
steps	Step[]	Telepítési lépések gyűjteménye.

Step

Objektum

A telepítési utasítás lépésének frissítése.

Name	Típus	Alapértelmezett érték	Description
description	string minLength: 1 maxLength: 64		Lépés leírása.
files	string[]		A végrehajtás során a kezelőnek átadni kívánt fájlnevek gyűjteménye. Kötelező, ha a lépés típusa beágyazott.
handler	string minLength: 1 maxLength: 32		A lépést végrehajtó kezelő identitása. Kötelező, ha a lépés típusa beágyazott.
handlerProperties	object		A végrehajtás során a kezelőnek átadni kívánt paraméterek.
type	StepType	inline	Lépés típusa.
updateId	UpdateId		Hivatkozott gyermekfrissítési identitás. Kötelező, ha a lépés típusa hivatkozás.

StepType

Enumerálás

Lépés típusa.

Érték	Description
inline
reference

Update

Objektum

Metaadatok frissítése.

Name	Típus	Alapértelmezett érték	Description
compatibility	object[]		A frissítéskompatibilitási információk listája.
createdDateTime	string (date-time)		Dátum és idő (UTC) a frissítés létrehozásakor.
description	string minLength: 1 maxLength: 512		A létrehozó által megadott frissítési leírás.
etag	string		ETag frissítése.
friendlyName	string minLength: 1 maxLength: 512		Az importáló által megadott rövid frissítés neve.
importedDateTime	string (date-time)		A frissítés importálásának dátuma és időpontja (UTC).
installedCriteria	string		Az Eszközfrissítési ügyfél által értelmezett sztring annak megállapítására, hogy a frissítés telepítve van-e az eszközön. Elavult a legújabb importálási jegyzékséma.
instructions	Instructions		Frissítési telepítési utasítások.
isDeployable	boolean	True	Azt jelzi, hogy a frissítés önállóan telepíthető-e egy eszközre.
manifestVersion	string		A frissítés importálásához használt jegyzék sémaverziója.
referencedBy	UpdateId[]		A frissítésre hivatkozó frissítési identitások listája.
scanResult	string		Az összesített vizsgálati eredmények frissítése (a hasznos adatfájl-vizsgálati eredmények alapján számítva).
updateId	UpdateId		Identitás frissítése.
updateType	string		Frissítés típusa. Elavult a legújabb importálási jegyzékséma.

UpdateId

Objektum

Frissítésazonosító.

Name	Típus	Description
name	string	Frissítés neve.
provider	string	Frissítési szolgáltató.
version	string	Verzió frissítése.

UpdateList

Objektum

A frissítések listája.

Name	Típus	Description
nextLink	string	Az elemek következő oldalára mutató hivatkozás.
value	Update[]	A lapozható elemek gyűjteménye.

Megosztás:

Device Update - List Updates

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

DeviceUpdate_ListUpdates

Mintakérelem

Mintaválasz

Definíciók

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList