Delen via


Device Update - List Updates

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

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01
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 IoT Hub accounteindpunt (alleen hostnaam, geen protocol).

instanceId
path True

string

De apparaatupdate voor IoT Hub accountinstantie-id.

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 de 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 is.

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

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

Voorbeeldrespons

{
  "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 specifiekere informatie dan het huidige object over de fout.

Instructions
Step

Installatie-instructiestap bijwerken.

StepType

Staptype.

Update

Metagegevens bijwerken.

UpdateId

Id bijwerken.

UpdateList

De lijst met updates.

Error

Foutdetails.

Name Type Description
code

string

Door de server gedefinieerde foutcode.

details

Error[]

Een matrix met fouten die tot de gerapporteerde fout hebben geleid.

innererror

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Een door mensen leesbare weergave van de fout.

occurredDateTime

string

De datum en tijd in UTC waarop de fout is opgetreden.

target

string

Het doel van de fout.

ErrorResponse

Veelvoorkomende foutreactie.

Name Type Description
error

Error

De foutdetails.

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

Name Type Description
code

string

Een specifiekere foutcode dan de fout die is opgegeven.

errorDetail

string

De interne fout of het uitzonderingsbericht.

innerError

InnerError

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Een door mensen leesbare weergave van de fout.

Instructions

Name Type Description
steps

Step[]

Verzameling installatiestappen.

Step

Installatie-instructiestap bijwerken.

Name Type Default value Description
description

string

Beschrijving van stap.

files

string[]

Verzameling bestandsnamen die tijdens de uitvoering moeten worden doorgegeven aan de handler. Vereist als het staptype inline is.

handler

string

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 onderliggende update-identiteit. Vereist als staptype een verwijzing is.

StepType

Staptype.

Name Type Description
inline

string

reference

string

Update

Metagegevens bijwerken.

Name Type Default value Description
compatibility

object[]

Lijst met informatie over updatecompatibiliteit.

createdDateTime

string

De datum en tijd in UTC waarop de update is gemaakt.

description

string

Beschrijving bijwerken die is opgegeven door de maker.

etag

string

ETag bijwerken.

friendlyName

string

Beschrijvende updatenaam die is opgegeven door de importeur.

importedDateTime

string

De datum en tijd in UTC waarop de update is geïmporteerd.

installedCriteria

string

Tekenreeks 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 zelfstandig op een apparaat kan worden geïmplementeerd.

manifestVersion

string

Schemaversie van het manifest dat wordt gebruikt om de update te importeren.

referencedBy

UpdateId[]

Lijst met update-id's die naar deze update verwijzen.

scanResult

string

Samengeteld scanresultaat bijwerken (berekend op basis van scanresultaten van nettoladingbestanden).

updateId

UpdateId

Identiteit bijwerken.

updateType

string

Updatetype. Afgeschaft in het meest recente importmanifestschema.

UpdateId

Id bijwerken.

Name Type Description
name

string

Naam bijwerken.

provider

string

Provider bijwerken.

version

string

Versie bijwerken.

UpdateList

De lijst met updates.

Name Type Description
nextLink

string

De koppeling naar de volgende pagina met items.

value

Update[]

De verzameling wisselbare items.