Device Update - List Updates

Tjänst:: Device Update

API-version:: 2022-10-01

Hämta en lista över alla uppdateringar som har importerats till Enhetsuppdatering för IoT Hub.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (url)	Enhetsuppdatering för IoT Hub-kontoslutpunkten (endast värdnamn, inget protokoll).
instanceId	path	True	string	Enhetsuppdatering för IoT Hub-kontoinstansidentifierare.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.
filter	query		string	Valfritt att filtrera uppdateringar efter isDeployable-egenskapen.
search	query		string	Begär uppdateringar som matchar ett fritextsökningsuttryck.

Svar

Name	Typ	Description
200 OK	UpdateList	Alla importerade uppdateringar eller en tom lista om det inte finns någon.
Other Status Codes	ErrorResponse	Standardsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://api.adu.microsoft.com/.default	Standardauktoriseringsomfång.

Exempel

DeviceUpdate_ListUpdates

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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\""
    }
  ]
}

Definitioner

Name	Description
Error	Felinformation.
ErrorResponse	Vanligt felsvar.
InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
Instructions
Step	Uppdatera installationsinstruktionssteget.
StepType	Stegtyp.
Update	Uppdatera metadata.
UpdateId	Uppdatera identifierare.
UpdateList	Listan över uppdateringar.

Error

Objekt

Felinformation.

Name	Typ	Description
code	string	Serverdefinierad felkod.
details	Error[]	En matris med fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
occurredDateTime	string (date-time)	Datum och tid i UTC när felet inträffade.
target	string	Målet för felet.

ErrorResponse

Objekt

Vanligt felsvar.

Name	Typ	Description
error	Error	Felinformationen.

InnerError

Objekt

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
errorDetail	string	Det interna felet eller undantagsmeddelandet.
innerError	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.

Instructions

Objekt

Name	Typ	Description
steps	Step[]	Samling installationssteg.

Step

Objekt

Uppdatera installationsinstruktionssteget.

Name	Typ	Standardvärde	Description
description	string minLength: 1 maxLength: 64		Stegbeskrivning.
files	string[]		Samling filnamn som ska skickas till hanteraren under körningen. Krävs om stegtypen är infogad.
handler	string minLength: 1 maxLength: 32		Identitet för den hanterare som ska utföra det här steget. Krävs om stegtypen är infogad.
handlerProperties	object		Parametrar som ska skickas till hanteraren under körningen.
type	StepType	inline	Stegtyp.
updateId	UpdateId		Refererade till underordnad uppdateringsidentitet. Krävs om stegtypen är referens.

StepType

Uppräkning

Stegtyp.

Värde	Description
inline
reference

Update

Objekt

Uppdatera metadata.

Name	Typ	Standardvärde	Description
compatibility	object[]		Lista över uppdateringskompatibilitetsinformation.
createdDateTime	string (date-time)		Datum och tid i UTC när uppdateringen skapades.
description	string minLength: 1 maxLength: 512		Uppdateringsbeskrivning som angetts av skaparen.
etag	string		Uppdatera ETag.
friendlyName	string minLength: 1 maxLength: 512		Eget uppdateringsnamn som anges av importören.
importedDateTime	string (date-time)		Datum och tid i UTC när uppdateringen importerades.
installedCriteria	string		Sträng som tolkas av enhetsuppdateringsklienten för att avgöra om uppdateringen är installerad på enheten. Inaktuellt i det senaste importmanifestschemat.
instructions	Instructions		Uppdatera installationsanvisningarna.
isDeployable	boolean	True	Om uppdateringen kan distribueras till en enhet på egen hand.
manifestVersion	string		Schemaversion av manifestet som används för att importera uppdateringen.
referencedBy	UpdateId[]		Lista över uppdateringsidentiteter som refererar till den här uppdateringen.
scanResult	string		Uppdatera aggregerat genomsökningsresultat (beräknat från nyttolastfilgenomsökningsresultat).
updateId	UpdateId		Uppdatera identitet.
updateType	string		Uppdateringstyp. Inaktuellt i det senaste importmanifestschemat.

UpdateId

Objekt

Uppdatera identifierare.

Name	Typ	Description
name	string	Uppdateringsnamn.
provider	string	Uppdateringsprovider.
version	string	Uppdatera version.

UpdateList

Objekt

Listan över uppdateringar.

Name	Typ	Description
nextLink	string	Länken till nästa sida med objekt.
value	Update[]	Samlingen med sidiga objekt.

Dela via

Device Update - List Updates

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

DeviceUpdate_ListUpdates

Exempelbegäran

Exempelsvar

Definitioner

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList