Az IoT Edge-ügynök és az IoT Edge Hub-modul ikerpéldányainak tulajdonságai
A következőkre vonatkozik:
IoT Edge 1.5
Fontos
Az IoT Edge 1.5 LTS a támogatott kiadás. Az IoT Edge 1.4 LTS 2024. november 12-én megszűnik. Ha egy korábbi kiadáson dolgozik, olvassa el az IoT Edge frissítése című témakört.
Az IoT Edge-ügynök és az IoT Edge Hub két modul, amelyek az IoT Edge-futtatókörnyezetet alkotják. Az egyes futtatókörnyezeti modulok feladataival kapcsolatos további információkért lásd az Azure IoT Edge-futtatókörnyezet és architektúrájának ismertetése című témakört.
Ez a cikk a futtatókörnyezeti modul ikerpéldányainak kívánt tulajdonságait és jelentett tulajdonságait ismerteti. A modulok IoT Edge-eszközökön való üzembe helyezésével kapcsolatos további információkért lásd : Modulok üzembe helyezése és útvonalak létrehozása az IoT Edge-ben.
A modul ikermodulja a következőket tartalmazza:
Kívánt tulajdonságok. A megoldás háttérrendszere beállíthatja a kívánt tulajdonságokat, és a modul elolvashatja őket. A modul értesítést is kaphat a kívánt tulajdonságok változásairól. A kívánt tulajdonságok és a jelentett tulajdonságok a modul konfigurációjának vagy feltételeinek szinkronizálására szolgálnak.
Jelentett tulajdonságok. A modul beállíthatja a jelentett tulajdonságokat, és a megoldás háttérrendszere elolvashatja és lekérdezheti őket. A jelentett tulajdonságok és a kívánt tulajdonságok a modul konfigurációjának vagy feltételeinek szinkronizálására szolgálnak.
EdgeAgent kívánt tulajdonságok
A rendszer meghívja $edgeAgent az IoT Edge-ügynök modul ikerpéldányát, és koordinálja az eszközön futó IoT Edge-ügynök és az IoT Hub közötti kommunikációt. A kívánt tulajdonságok akkor vannak beállítva, ha egy központi telepítési jegyzéket alkalmaz egy adott eszközön egy egyeszközes vagy nagy léptékű üzembe helyezés részeként.
| Tulajdonság | Leírás | Kötelező |
|---|---|---|
| imagePullPolicy | Mikor kell lekérni a képet az OnCreate vagy a Never (Soha nem használható, ha a kép már az eszközön van) | Igen |
| restartPolicy | Mikor kell újraindítani a modult. Lehetséges értékek: Soha: ne indítsa újra a modult, ha nem fut, Mindig: mindig indítsa újra a modult, ha nem fut, kifogástalan állapotú: indítsa újra a modult, ha nem megfelelő. Az állapot-ellenőrzés alapján a Docker nem megfelelő állapotot jelez, például "Nem kifogástalan – a tároló nem működik megfelelően", Sikertelen: újraindítás sikertelen esetben. | Igen |
| runtime.type | Dockernek kell lennie. | Igen |
| runtime.settings.minDockerVersion | Állítsa be az üzembe helyezési jegyzék által megkövetelt minimális Docker-verzióra. | Igen |
| runtime.settings.loggingOptions | Sztringezett JSON, amely az IoT Edge-ügynöktároló naplózási beállításait tartalmazza. Docker-naplózási beállítások | Nem |
| runtime.settings.registryCredentials. {registryId}.username | A tárolóregisztrációs adatbázis felhasználóneve. Az Azure Container Registry esetében a felhasználónév általában a beállításjegyzék neve. A regisztrációs adatbázis hitelesítő adatai minden privát modul lemezképéhez szükségesek. | Nem |
| runtime.settings.registryCredentials. {registryId}.password | A tárolóregisztrációs adatbázis jelszava. | Nem |
| runtime.settings.registryCredentials. {registryId}.address | A tárolóregisztrációs adatbázis címe. Az Azure Container Registry esetében a cím általában {registry name}.azurecr.io. | Nem |
| schemaVersion | 1.0 vagy 1.1. Az 1.1-es verzió az IoT Edge 1.0.10-es verziójával lett bevezetve, és ajánlott. | Igen |
| status | A modul kívánt állapota: Futtatás vagy leállítás. | Kötelező |
| systemModules.edgeAgent.type | Dockernek kell lennie. | Igen |
| systemModules.edgeAgent.startupOrder | A modul indítási sorrendben megadott helyének egész számértéke. A 0 az első, a maximális egész szám (4294967295) pedig az utolsó. Ha nincs megadva érték, az alapértelmezett érték a maximális egész szám. | Nem |
| systemModules.edgeAgent.settings.image | Az IoT Edge-ügynök képének URI-ja. Az IoT Edge-ügynök jelenleg nem tudja frissíteni magát. | Igen |
| systemModules.edgeAgent.settings.createOptions | Sztringezett JSON, amely az IoT Edge-ügynöktároló létrehozásának lehetőségeit tartalmazza. A Docker létrehozási beállításai | Nem |
| systemModules.edgeAgent.configuration.id | A modult üzembe helyező üzembe helyezés azonosítója. | Az IoT Hub akkor állítja be ezt a tulajdonságot, ha a jegyzékfájl üzembe helyezéssel van alkalmazva. Nem része az üzembehelyezési jegyzéknek. |
| systemModules.edgeHub.type | Dockernek kell lennie. | Igen |
| systemModules.edgeHub.status | Futnia kell. | Igen |
| systemModules.edgeHub.restartPolicy | Mindig így kell lennie. | Igen |
| systemModules.edgeHub.startupOrder | Egy egész szám, amelynél a pont egy modul indítási sorrendben van. A 0 az első, a maximális egész szám (4294967295) pedig az utolsó. Ha nincs megadva érték, az alapértelmezett érték a maximális egész szám. | Nem |
| systemModules.edgeHub.settings.image | Az IoT Edge-központ képének URI-ja. | Igen |
| systemModules.edgeHub.settings.createOptions | Sztringezett JSON, amely az IoT Edge Hub-tároló létrehozásának lehetőségeit tartalmazza. A Docker létrehozási beállításai | Nem |
| systemModules.edgeHub.configuration.id | A modult üzembe helyező üzembe helyezés azonosítója. | Az IoT Hub akkor állítja be ezt a tulajdonságot, ha a jegyzékfájl üzembe helyezéssel van alkalmazva. Nem része az üzembehelyezési jegyzéknek. |
| Modulok. {moduleId}.version | A modul verzióját képviselő, felhasználó által definiált sztring. | Igen |
| Modulok. {moduleId}.type | Dockernek kell lennie. | Igen |
| Modulok. {moduleId}.status | {a futtatás | leállt} | Igen |
| Modulok. {moduleId}.restartPolicy | {soha nem | mindig} | Igen |
| Modulok. {moduleId}.startupOrder | A modul indítási sorrendben megadott helyének egész számértéke. A 0 az első, a maximális egész szám (4294967295) pedig az utolsó. Ha nincs megadva érték, az alapértelmezett érték a maximális egész szám. | Nem |
| Modulok. {moduleId}.imagePullPolicy | {on-create | never} | Nem |
| Modulok. {moduleId}.env | A modulnak átadni kívánt környezeti változók listája. A formátumot "<name>": {"value": "<value>"}veszi fel. |
Nem |
| Modulok. {moduleId}.settings.image | A modul képének URI-ja. | Igen |
| Modulok. {moduleId}.settings.createOptions | Sztringezett JSON, amely a modultároló létrehozásának lehetőségeit tartalmazza. A Docker létrehozási beállításai | Nem |
| Modulok. {moduleId}.configuration.id | A modult üzembe helyező üzembe helyezés azonosítója. | Az IoT Hub akkor állítja be ezt a tulajdonságot, ha a jegyzékfájl üzembe helyezéssel van alkalmazva. Nem része az üzembehelyezési jegyzéknek. |
| Verzió | Az aktuális iteráció, amely verzióval, véglegesítéssel és buildeléssel rendelkezik. | Nem |
EdgeAgent jelentett tulajdonságok
Az IoT Edge-ügynök jelentett tulajdonságai három fő információt tartalmaznak:
- Az utoljára látott kívánt tulajdonságok alkalmazásának állapota;
- Az eszközön jelenleg futó modulok állapota az IoT Edge-ügynök jelentése szerint; és
- Az eszközön jelenleg futó kívánt tulajdonságok másolata.
Az aktuális kívánt tulajdonságok másolata hasznos annak megállapításához, hogy az eszköz alkalmazta-e a legújabb üzembe helyezést, vagy továbbra is futtat egy korábbi üzembehelyezési jegyzékfájlt.
Feljegyzés
Az IoT Edge-ügynök jelentett tulajdonságai hasznosak, mivel az IoT Hub lekérdezési nyelvével lekérdezhetők a nagy léptékű üzemelő példányok állapotának vizsgálatához. Az IoT Edge-ügynök állapottulajdonságaival kapcsolatos további információkért tekintse meg az IoT Edge egyszeri vagy nagy léptékű üzemelő példányainak ismertetése című témakört.
Az alábbi táblázat nem tartalmazza a kívánt tulajdonságokból másolt információkat.
| Tulajdonság | Leírás |
|---|---|
| lastDesiredStatus.code | Ez az állapotkód az IoT Edge-ügynök által utoljára látott kívánt tulajdonságokra hivatkozik. Engedélyezett értékek: 200 Sikeres, 400 Érvénytelen konfiguráció, 412 Érvénytelen sémaverzió, 417 A kívánt tulajdonságok üresek, 500 sikertelenek. |
| lastDesiredStatus.description | Az állapot szöveges leírása. |
| lastDesiredVersion | Ez az egész szám az IoT Edge-ügynök által feldolgozott kívánt tulajdonságok utolsó verzióját jelenti. |
| runtime.platform.OS | Az eszközön futó operációs rendszer jelentése. |
| runtime.platform.architecture | Az eszközön található CPU architektúrájának jelentése. |
| schemaVersion | A jelentett tulajdonságok sémaverziója. |
| systemModules.edgeAgent.runtimeStatus | Az IoT Edge-ügynök jelentett állapota: {running | unhealthy}. |
| systemModules.edgeAgent.statusDescription | Az IoT Edge-ügynök jelentett állapotának szöveges leírása. |
| systemModules.edgeAgent.exitCode | Az IoT Edge-ügynöktároló által jelentett kilépési kód, ha a tároló kilép. |
| systemModules.edgeAgent.lastStartTimeUtc | Az IoT Edge-ügynök utolsó indításának időpontja. |
| systemModules.edgeAgent.lastExitTimeUtc | Az IoT Edge-ügynök utolsó kilépésének időpontja. |
| systemModules.edgeHub.runtimeStatus | Az IoT Edge Hub állapota: { a futtatás | leállt | | , a visszakapcsolás | nem kifogástalan }. |
| systemModules.edgeHub.statusDescription | Az IoT Edge Hub állapotának szöveges leírása, ha nem megfelelő. |
| systemModules.edgeHub.exitCode | Az IoT Edge hubtároló által jelentett kilépési kód, ha a tároló kilép. |
| systemModules.edgeHub.lastStartTimeUtc | Az IoT Edge Hub utolsó indításának időpontja. |
| systemModules.edgeHub.lastExitTimeUtc | Az IoT Edge hub utolsó kilépésének időpontja. |
| systemModules.edgeHub.lastRestartTimeUtc | Az IoT Edge Hub utolsó újraindításának időpontja. |
| systemModules.edgeHub.restartCount | A modul újraindításának hányszor volt az újraindítási szabályzat részeként. |
| Modulok. {moduleId}.runtimeStatus | A modul állapota: { a futtatás | leállt | | , és a visszakapcsolás | nem kifogástalan }. |
| Modulok. {moduleId}.statusDescription | A modul állapotának szöveges leírása, ha nem megfelelő. |
| Modulok. {moduleId}.exitCode | A modultároló által jelentett kilépési kód, ha a tároló kilép. |
| Modulok. {moduleId}.lastStartTimeUtc | A modul utolsó indításának időpontja. |
| Modulok. {moduleId}.lastExitTimeUtc | A modul utolsó kilépésének időpontja. |
| Modulok. {moduleId}.lastRestartTimeUtc | A modul utolsó újraindításának időpontja. |
| Modulok. {moduleId}.restartCount | A modul újraindításának hányszor volt az újraindítási szabályzat részeként. |
| Verzió | A kép verziója. Például: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
Az EdgeHub kívánt tulajdonságai
Az IoT Edge Hub modul ikermoduljának meghívása $edgeHub és koordinálása az eszközön futó IoT Edge Hub és az IoT Hub közötti kommunikációt koordinálja. A kívánt tulajdonságok akkor vannak beállítva, ha egy központi telepítési jegyzéket alkalmaz egy adott eszközön egy egyeszközes vagy nagy léptékű üzembe helyezés részeként.
| Tulajdonság | Leírás | Az üzembehelyezési jegyzékben kötelező megadni |
|---|---|---|
| schemaVersion | 1.0 vagy 1.1. Az 1.1-es verzió az IoT Edge 1.0.10-es verziójával lett bevezetve, és ajánlott. | Igen |
| Útvonalak. {routeName} | Egy IoT Edge-központ útvonalát jelképező sztring. További információ: Útvonalak deklarálása. | Az routes elem jelen lehet, de üres. |
| storeAndForwardConfiguration.timeToLiveSecs | Az IoT Edge Hub által az útválasztási végpontokról leválasztott üzeneteket az IoT Edge Hub által másodpercben megadott idő tartja meg, függetlenül attól, hogy az IoT Hub vagy egy helyi modul. Ez az idő továbbra is megmarad az áramkimaradások vagy újraindítások során. További információ: Kapcsolat nélküli képességek. | Igen |
Az EdgeHub jelentett tulajdonságai
| Tulajdonság | Leírás |
|---|---|
| lastDesiredVersion | Ez az egész szám az IoT Edge Hub által feldolgozott kívánt tulajdonságok utolsó verziójára vonatkozik. |
| lastDesiredStatus.code | Az IoT Edge-központ által látott utolsó kívánt tulajdonságokra hivatkozó állapotkód. Engedélyezett értékek: 200 Sikeres, 400 Érvénytelen konfiguráció, 500 Sikertelen |
| lastDesiredStatus.description | Az állapot szöveges leírása. |
| Ügyfelek | Az edgeHubhoz az állapottal és az utolsó kapcsolódási időponttal csatlakozó összes ügyfél. Például: "clients": { "device2/SimulatedTemperatureSensor": { "status": "Connected", "lastConnectedTimeUtc": "2022-11-17T21:49:16.4781564Z" } }. |
| Ügyfelek. {device or moduleId}.status | Az eszköz vagy modul kapcsolati állapota. Lehetséges értékek {connected | disconnected}. Csak a modulidentitások lehetnek leválasztott állapotban. Az IoT Edge Hubhoz csatlakozó alsóbb rétegbeli eszközök csak csatlakozáskor jelennek meg. |
| Ügyfelek. {device or moduleId}.lastConnectTime | Az eszköz vagy modul legutóbbi csatlakoztatása. |
| Ügyfelek. {device or moduleId}.lastDisconnectTime | Az eszköz vagy modul legutóbbi leválasztásakor. |
| schemaVersion | A jelentett tulajdonságok sémaverziója. |
| Verzió | A kép verziója. Például: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
Következő lépések
Ha tudni szeretné, hogyan használhatja ezeket a tulajdonságokat az üzembehelyezési jegyzékek összeállításához, olvassa el az IoT Edge-modulok használatának, konfigurálásának és újrafelhasználásának ismertetése című témakört.