Device Update - List Updates

Service:

Device Update

API-versie:

2022-10-01

Haal een lijst op met alle updates die zijn geïmporteerd in Device Update voor IoT Hub.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (url)	De apparaatupdate voor het eindpunt van het IoT Hub-account (alleen hostnaam, geen protocol).
instanceId	path	True	string	De apparaatupdate voor de exemplaar-id van het IoT Hub-account.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.
filter	query		string	Optioneel om updates te filteren op eigenschap isDeployable.
search	query		string	Updates aanvragen die overeenkomen met een zoekexpressie in vrije tekst.

Antwoorden

Name	Type	Description
200 OK	UpdateList	Alle geïmporteerde updates of een lege lijst als er geen updates zijn.
Other Status Codes	ErrorResponse	Standaardantwoord.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://api.adu.microsoft.com/.default	Standaardautorisatiebereik.

Voorbeelden

DeviceUpdate_ListUpdates

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Error	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
Instructions
Step	De installatie-instructiestap bijwerken.
StepType	Staptype.
Update	Metagegevens bijwerken.
UpdateId	Id bijwerken.
UpdateList	De lijst met updates.

Error

Object

Foutdetails.

Name	Type	Description
code	string	Door de server gedefinieerde foutcode.
details	Error[]	Een matrix met fouten die hebben geleid tot de gemelde fout.
innererror	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
occurredDateTime	string (date-time)	Datum en tijd in UTC wanneer de fout is opgetreden.
target	string	Het doel van de fout.

ErrorResponse

Object

Veelvoorkomende foutreactie.

Name	Type	Description
error	Error	De foutdetails.

InnerError

Object

Een object met meer specifieke informatie dan het huidige object over de fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan de foutcode die is opgegeven door de bijbehorende fout.
errorDetail	string	Het interne foutbericht of het uitzonderingsbericht.
innerError	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.

Instructions

Object

Name	Type	Description
steps	Step[]	Verzameling van installatiestappen.

Step

Object

De installatie-instructiestap bijwerken.

Name	Type	Default value	Description
description	string minLength: 1 maxLength: 64		Beschrijving van stap.
files	string[]		Verzameling bestandsnamen die tijdens de uitvoering aan de handler moeten worden doorgegeven. Vereist als het staptype inline is.
handler	string minLength: 1 maxLength: 32		Identiteit van handler die deze stap uitvoert. Vereist als het staptype inline is.
handlerProperties	object		Parameters die tijdens de uitvoering aan de handler moeten worden doorgegeven.
type	StepType	inline	Staptype.
updateId	UpdateId		Er wordt verwezen naar de identiteit van onderliggende updates. Vereist als het staptype verwijzing is.

StepType

Inventarisatie

Staptype.

Waarde	Description
inline
reference

Update

Object

Metagegevens bijwerken.

Name	Type	Default value	Description
compatibility	object[]		Lijst met updatecompatibiliteitsgegevens.
createdDateTime	string (date-time)		De datum en tijd in UTC waarop de update is gemaakt.
description	string minLength: 1 maxLength: 512		Beschrijving bijwerken die is opgegeven door de maker.
etag	string		ETag bijwerken.
friendlyName	string minLength: 1 maxLength: 512		Beschrijvende updatenaam die is opgegeven door importer.
importedDateTime	string (date-time)		Datum en tijd in UTC toen de update werd geïmporteerd.
installedCriteria	string		Tekenreeks die wordt geïnterpreteerd door de Device Update-client om te bepalen of de update op het apparaat is geïnstalleerd. Afgeschaft in het meest recente importmanifestschema.
instructions	Instructions		Installatie-instructies bijwerken.
isDeployable	boolean	True	Of de update op een apparaat zelf kan worden geïmplementeerd.
manifestVersion	string		Schemaversie van het manifest dat wordt gebruikt voor het importeren van de update.
referencedBy	UpdateId[]		Lijst met update-identiteiten die naar deze update verwijzen.
scanResult	string		Samenvoegingsscanresultaat bijwerken (berekend op basis van scanresultaten van nettoladingbestanden).
updateId	UpdateId		Identiteit bijwerken.
updateType	string		Type update. Afgeschaft in het meest recente importmanifestschema.

UpdateId

Object

Id bijwerken.

Name	Type	Description
name	string	Naam bijwerken.
provider	string	Updateprovider.
version	string	Updateversie.

UpdateList

Object

De lijst met updates.

Name	Type	Description
nextLink	string	De koppeling naar de volgende pagina met items.
value	Update[]	De verzameling pagina-items.