Device Update - List Updates

Služba:: Device Update

Verze rozhraní API:: 2022-10-01

Získejte seznam všech aktualizací importovaných do služby Device Update pro IoT Hub.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (url)	Koncový bod účtu služby Device Update pro IoT Hub (pouze název hostitele, žádný protokol).
instanceId	path	True	string	Identifikátor instance účtu služby IoT Hub pro službu Device Update.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.
filter	query		string	Volitelné pro filtrování aktualizací podle isDeployable vlastnost.
search	query		string	Žádosti o aktualizace odpovídající výrazu freetextového vyhledávání

Odpovědi

Name	Typ	Description
200 OK	UpdateList	Všechny importované aktualizace nebo prázdný seznam, pokud žádné nejsou.
Other Status Codes	ErrorResponse	Výchozí odpověď.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
https://api.adu.microsoft.com/.default	Výchozí obor autorizace

Příklady

DeviceUpdate_ListUpdates

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kó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\""
    }
  ]
}

Definice

Name	Description
Error	Podrobnosti o chybě
ErrorResponse	Běžná chybová odpověď
InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
Instructions
Step	Aktualizujte krok s pokyny k instalaci.
StepType	Typ kroku
Update	Aktualizujte metadata.
UpdateId	Aktualizovat identifikátor.
UpdateList	Seznam aktualizací.

Error

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	string	Kód chyby definovaný serverem
details	Error[]	Pole chyb, které vedly k nahlášené chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
occurredDateTime	string (date-time)	Datum a čas ve standardu UTC, kdy došlo k chybě.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď

Name	Typ	Description
error	Error	Podrobnosti o chybě.

InnerError

Objekt

Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.

Name	Typ	Description
code	string	Konkrétnější kód chyby, než jaký poskytla chyba obsahující.
errorDetail	string	Vnitřní chybová zpráva nebo zpráva o výjimce.
innerError	InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.

Instructions

Objekt

Name	Typ	Description
steps	Step[]	Kolekce kroků instalace

Step

Objekt

Aktualizujte krok s pokyny k instalaci.

Name	Typ	Default value	Description
description	string minLength: 1 maxLength: 64		Popis kroku
files	string[]		Kolekce názvů souborů, které se mají předat obslužné rutině během provádění Vyžaduje se, pokud je typ kroku vložený.
handler	string minLength: 1 maxLength: 32		Identita obslužné rutiny, která provede tento krok. Vyžaduje se, pokud je typ kroku vložený.
handlerProperties	object		Parametry, které se mají předat obslužné rutině během provádění
type	StepType	inline	Typ kroku
updateId	UpdateId		Odkazovaná podřízená identita aktualizace Vyžaduje se, pokud je typ kroku odkazem.

StepType

Výčet

Typ kroku

Hodnota	Description
inline
reference

Update

Objekt

Aktualizujte metadata.

Name	Typ	Default value	Description
compatibility	object[]		Seznam informací o kompatibilitě aktualizací
createdDateTime	string (date-time)		Datum a čas ve standardu UTC, kdy byla aktualizace vytvořena.
description	string minLength: 1 maxLength: 512		Aktualizujte popis určený tvůrcem.
etag	string		Aktualizovat značku ETag
friendlyName	string minLength: 1 maxLength: 512		Popisný název aktualizace určený dovozcem.
importedDateTime	string (date-time)		Datum a čas ve standardu UTC při importu aktualizace
installedCriteria	string		Řetězec interpretovaný klientem Device Update, aby zjistil, jestli je na zařízení nainstalovaná aktualizace. Zastaralé v nejnovějším schématu manifestu importu
instructions	Instructions		Aktualizujte pokyny k instalaci.
isDeployable	boolean	True	Jestli je možné aktualizaci nasadit do zařízení samostatně.
manifestVersion	string		Verze schématu manifestu použitého k importu aktualizace
referencedBy	UpdateId[]		Seznam aktualizačních identit, které odkazují na tuto aktualizaci
scanResult	string		Aktualizace agregovaného výsledku kontroly (vypočítaného z výsledků prohledávání souboru datové části)
updateId	UpdateId		Aktualizujte identitu.
updateType	string		Typ aktualizace Zastaralé v nejnovějším schématu manifestu importu

UpdateId

Objekt

Aktualizovat identifikátor.

Name	Typ	Description
name	string	Aktualizovat název.
provider	string	Zprostředkovatel aktualizací
version	string	Aktualizace verze

UpdateList

Objekt

Seznam aktualizací.

Name	Typ	Description
nextLink	string	Odkaz na další stránku položek
value	Update[]	Kolekce stránkovatelných položek.

Sdílet prostřednictvím

Device Update - List Updates

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

DeviceUpdate_ListUpdates

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList