Megosztás a következőn keresztül:


Device Update - List Updates

A IoT Hub eszközfrissítésbe importált frissítések listájának lekérése.

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-paraméterek

Name In Kötelező Típus Description
endpoint
path True

string

url

Az eszközfrissítés IoT Hub fiókvégponthoz (csak állomásnév, protokoll nélkül).

instanceId
path True

string

Az eszközfrissítés IoT Hub fiókpéldány-azonosítóhoz.

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

Minden 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 Flow

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

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

Mintaválasz

{
  "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 útmutató frissítési lépése.

StepType

Lépés típusa.

Update

Metaadatok frissítése.

UpdateId

Frissítse az azonosítót.

UpdateList

A frissítések listája.

Error

Hiba részletei.

Name Típus Description
code

string

Kiszolgáló által definiált hibakód.

details

Error[]

Egy 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 emberi olvasásra alkalmas ábrázolása.

occurredDateTime

string

A hiba előfordulásának dátuma és időpontja (UTC).

target

string

A hiba célja.

ErrorResponse

Gyakori hibaválasz.

Name Típus Description
error

Error

A hiba részletei.

InnerError

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 emberi olvasásra alkalmas ábrázolása.

Instructions

Name Típus Description
steps

Step[]

Telepítési lépések gyűjteménye.

Step

A telepítési útmutató frissítési lépése.

Name Típus Alapértelmezett érték Description
description

string

Lépés leírása.

files

string[]

A kezelőnek a végrehajtás során átadandó fájlnevek gyűjteménye. Kötelező, ha a lépés típusa beágyazott.

handler

string

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 átadandó 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

Lépés típusa.

Name Típus Description
inline

string

reference

string

Update

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

A frissítés létrehozásának dátuma és időpontja (UTC).

description

string

A létrehozó által megadott frissítési leírás.

etag

string

Az ETag frissítése.

friendlyName

string

Az importáló által megadott rövid frissítésnév.

importedDateTime

string

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émában.

instructions

Instructions

Frissítési telepítési utasítások.

isDeployable

boolean

True

Azt határozza meg, hogy a frissítés önállóan is üzembe helyezhető-e egy eszközön.

manifestVersion

string

A frissítés importálásához használt jegyzékfájl 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ény frissítése (a hasznos adatfájl vizsgálati eredményeiből 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émában.

UpdateId

Frissítse az azonosítót.

Name Típus Description
name

string

Frissítés neve.

provider

string

Frissítse a szolgáltatót.

version

string

Verzió frissítése.

UpdateList

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.