Az Azure Device Update for IoT Hub importálási jegyzékséma

Amikor egy frissítést importál az Iot Hubhoz készült Azure Device Update-be, elküld egy társított JSON-importálási jegyzékfájlt is, amely meghatározza a frissítéssel kapcsolatos fontos információkat. Ez a cikk a JSON-importálási jegyzékfájl létrehozásához használt sémát ismerteti.

Az importálási jegyzék fogalmaival és a fájlstruktúrával kapcsolatos további információkért tekintse meg az Azure Device Update for IoT Hub importálási jegyzékét. A fájl létrehozásának módjáról további információt az IoT Hub eszközfrissítésébe való importáláshoz szükséges frissítés előkészítése című témakörben talál.

Séma

Az importálási jegyzék JSON-sémája a SchemaStore.org található, és a következő tulajdonságokból áll. Más tulajdonságok nem engedélyezettek.

Objektum frissítése

Az updateID objektum minden frissítés egyedi azonosítója.

Más tulajdonságok nem engedélyezettek.

Példa:

{
  "updateId": {
    "provider": "Contoso",
    "name": "Toaster",
    "version": "1.0"
  }
}

Kompatibilitási objektum

Az compatibility objektum egy olyan eszköz 1–5 tulajdonságát írja le, amellyel ez a frissítés kompatibilis. Minden tulajdonság egy string típusnév-érték pár. A névnek 1–32 karakter hosszúnak, az értéknek pedig 1–64 karakter hosszúnak kell lennie. Nem használhatja ugyanazt a kompatibilitási tulajdonságkészletet több frissítésszolgáltatóval és névkombinációval.

Példa:

{
  "compatibility": [
    {
      "manufacturer": "Contoso",
      "model": "Toaster"
    }
  ]
}

Utasítások objektum

Az instructions objektum tartalmazza a frissítés telepítési utasításait. Az utasítások objektuma tartalmazza a steps végrehajtandó műveletek listáját. Más tulajdonságok nem engedélyezettek.

A lépések lehetnek végrehajtható kódok, vagy más frissítésekre mutató hivatkozások. A lépésobjektum alapértelmezett inline értéke, ha nincs type megadva érték.

Példa:

{
  "instructions": {
    "steps": [
      {
        "type": "inline",
        ...
      },
      {
        "type": "reference",
        ...
      }
    ]
  }
}

Beágyazott lépésobjektum

A inline lépésobjektumok olyan telepítési utasítási lépések, amelyek kódvégrehajtást hajtanak végre.

Más tulajdonságok nem engedélyezettek.

Példa:

{
  "steps": [
    {
      "description": "pre-install script",
      "handler": "microsoft/script:1",
      "handlerProperties": {
        "arguments": "--pre-install"
      },
      "files": [
        "configure.sh"
      ]
    }
  ]
}

Referencialépés-objektum

A reference lépésobjektum egy telepítési utasítás lépés egy másik frissítés telepítéséhez.

Más tulajdonságok nem engedélyezettek.

Példa:

{
  "steps": [
    {
      "type": "reference",
      "updateId": {
        "provider": "Contoso",
        "name": "Toaster.HeatingElement",
        "version": "1.0"
      }
    }
  ]
}

Fájlok objektum

Minden files objektum egy frissítési hasznos adatfájl, például bináris, belső vezérlőprogram vagy szkriptfájl, amelyeknek egyedinek kell lenniük egy frissítésen belül.

Más tulajdonságok nem engedélyezettek.

Példa:

{
  "files": [
    {  
      "fileName": "full-image-file-name",
      "sizeInBytes": 12345,
      "hashes": {...},
      "relatedFiles": [
        {
          "fileName": "delta-from-v1-file-name",
          "sizeInBytes": 1234,
          "hashes": {
            "SHA256": "delta-from-v1-file-hash"
          },
          "properties": {...}
        }  
      ],
      "downloadHandler": {
        "id": "microsoft/delta:1"
        }
    }
  ]
}

Kivonat objektum

Az hashes objektum base64 kódolású fájlkivonatokat tartalmaz, kulcsként az algoritmusnevekkel. Legalább az SHA-256 algoritmust meg kell adni, és más algoritmusokat is meg lehet adni, ha az ügynök támogatja. A kivonat helyes kiszámításának módját az AduUpdate.psm1 szkriptben találhatja Get-AduFileHashes meg.

Más tulajdonságok is engedélyezettek.

Példa:

{
  "hashes": {
    "sha256": "/CD7Sn6fiknWa3NgcFjGlJ+ccA81s1QAXX4oo5GHiFA="
  }
}

relatedFiles objektum

Az relatedFiles objektum egy vagy több elsődleges hasznos adatfájlhoz kapcsolódó fájlgyűjteményt tartalmaz. További információ: A kapcsolódó fájlok funkció használata több frissítési fájlra való hivatkozással.

Más tulajdonságok is engedélyezettek.

Példa:

"relatedFiles": [
  {
    "filename": "in1_in2_deltaupdate.dat",
    "sizeInBytes": 102910752,
    "hashes": {
      "sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
    },
    "properties": {
      "microsoft.sourceFileHashAlgorithm": "sha256",
      "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
    }
  }
],

downloadHandler objektum

Az downloadHandler objektum a kapcsolódó fájlok feldolgozását határozza meg.

Más tulajdonságok nem engedélyezettek.

Példa:

"downloadHandler": {
  "id": "microsoft/delta:1"
}

Kapcsolódó tartalom

• Fogalmak és jegyzék importálása
• Frissítés előkészítése importáláshoz
• Frissítés importálása