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

A kapcsolódó fájlok funkció használata több frissítési fájlra való hivatkozáshoz

  • Cikk

Akkor használja a kapcsolódó fájlok funkciót, ha egyetlen frissítésben kell kapcsolatot létesítenie a különböző frissítési fájlok között.

Amikor IoT Hub eszközfrissítésre importál egy frissítést, a frissítés hasznos adataival kapcsolatos metaadatokat tartalmazó importálási jegyzékfájlra van szükség. Az importálási jegyzékfájl fájlszintű metaadatai a legegyszerűbb esetben a frissítési hasznosadat-fájlok egybesimított listája lehetnek. Speciálisabb forgatókönyvek esetén azonban a kapcsolódó fájlok funkció lehetővé teszi több frissítési fájl közötti kapcsolatok megadását.

Amikor importálási jegyzékfájlt hoz létre a kapcsolódó fájlok funkcióval, hozzáadhat egy kapcsolódó fájlgyűjteményt egy vagy több elsődleges hasznosadat-fájlhoz. Erre a fogalomra példa az eszközfrissítési különbözeti frissítési funkció, amely kapcsolódó fájlokat használ egy teljes képfájlhoz társított változásfrissítés megadásához. A különbözeti forgatókönyvben a kapcsolódó fájlok funkció lehetővé teszi, hogy a teljes rendszerkép és a változásfrissítés egyetlen frissítési műveletként is importálható legyen, majd bármelyiket üzembe helyezheti egy eszközön. A kapcsolódó fájlok funkció azonban nem korlátozódik a különbözeti frissítésekre, mivel ügyfeleink a saját egyedi forgatókönyveiktől függően bővíthetők.

A kapcsolódó fájlok funkció az 5-ös vagy újabb verziójú importálási jegyzékekhez érhető el.

Ha kapcsolódó fájlokat ad hozzá egy importálási jegyzékfájlhoz, adja meg a következő információkat:

  • Fájl részletei

    Definiálja a kapcsolódó fájlokat a fájlnév, a méret és a kivonat megadásával.

  • Letöltéskezelő

    Adja meg, hogyan dolgozhatja fel ezeket a kapcsolódó fájlokat a célfájl létrehozásához. A feldolgozási módszert úgy adhatja meg, hogy belevesz egy downloadHandler tulajdonságot az importálási jegyzékbe. Ha nem üres gyűjteményt relatedFiles ad meg egy file elemben, a belevételre downloadHandler is szükség van. Megadhat egy downloadHandler egyszerű id tulajdonságot. A Letöltés kezelő id legfeljebb 64 ASCII-karakterből állhat.

  • Kapcsolódó fájlok tulajdonságai

    További metaadatokat adhat meg az eszköz frissítéskezelőjének, hogy tudja, hogyan értelmezheti és megfelelően használhatja a kapcsolódó fájlokként megadott fájlokat. Ez a metaadatok egy properties tulajdonságcsomag részeként lesznek hozzáadva a és relatedFile az file objektumokhoz.

További információ a kapcsolódó fájlok importálási sémájáról: relatedFiles objektum.

Az alábbi importálási mintajegyzék bemutatja, hogyan történik a kapcsolódó fájlok funkció használata a változásfrissítések importálásához. Ebben a példában láthatja, hogy a files szakaszban egy teljes kép van megadva (full-image-file-name) egy properties elemhez. Az properties elem alatt egy társított relatedFiles elem található. relatedFiles A szakaszban egy másik properties szakasz látható a delta frissítési fájlhoz (delta-from-v1-file-name), valamint egydownloadHandler, a megfelelő id listában szereplő elemhez (microsoft/delta:1).

Megjegyzés

Ez a példa különbözeti frissítésekkel mutatja be, hogyan hivatkozhat a kapcsolódó fájlokra. Ha funkcióként szeretné használni a különbözeti frissítéseket, további információt a deltafrissítési dokumentációban talál.

    {
      "updateId": {
        // provider, name, version
      },
      "compatibility": [
        {
          // manufacturer, model, etc.
        }
      ],
      "instructions": {
        "steps": [
          // Inline steps...
        ]
      },
      "files": [
        {  
          // standard file properties
          "fileName": "full-image-file-name",
          "sizeInBytes": 12345,
          "hashes": {
            "SHA256": "full-image-file-hash"
          },
          "mimeType": "application/octet-stream",
          // new properties
          "properties  ": {},
          "relatedFiles": [
            {
              // delta from version 1.0.0.0
              // standard file properties
              "fileName": "delta-from-v1-file-name",
              "sizeInBytes": 1234,
              "hashes": {
                "SHA256": "delta-from-v1-file-hash"
              },
              "mimeType": "application/octet-stream",
              // new properties
              "properties": {
                "microsoft.sourceFileHash": "delta-source-file-hash",
                "microsoft.sourceFileHashAlgorithm": "sha256"
              }
            }  
          ],
          // handler to download/process our related files
      "downloadHandler": {
        "id": "microsoft/delta:1"
      }
    }
  ],
  "createdDateTime": "2021-12-01T01:12:21Z",
  "manifestVersion": "5.0"
    }

Az az iot du init v5 parancs egy importálási jegyzékfájl létrehozásához támogatja a választható --related-file paramétert.

A --related-file paraméter a path és properties a kulcsot veszi fel:

--related-file path=<replace with path(s) to your delta file(s), including the full file name> properties='{"microsoft.sourceFileHashAlgorithm": "sha256", "microsoft.sourceFileHash": "<replace with the source SWU image file hash>"}'

Például:

az iot du update init v5 \
--update-provider Microsoft --update-name myBundled --update-version 2.0 \
--compat manufacturer=Contoso model=SpaceStation \
--step handler=microsoft/script:1 properties='{"arguments": "--pre"}' description="Pre-install script" \
--file path=/my/update/scripts/preinstall.sh downloadHandler=microsoft/delta:1 \
--related-file path=/my/update/scripts/related_preinstall.json properties='{"microsoft.sourceFileHashAlgorithm": "sha256"}' \
--step updateId.provider=Microsoft updateId.name=SwUpdate updateId.version=1.1 \
--step handler=microsoft/script:1 properties='{"arguments": "--post"}' description="Post-install script" \
--file path=/my/update/scripts/postinstall.sh

Következő lépések