Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
A következőre vonatkozik:
IoT Edge 1.5
Fontos
IoT Edge 1.5 LTS a támogatott kiadás. IoT Edge 1,4 LTS 2024. november 12-én véget ért. Ha korábbi kiadást használ, tekintse meg a Update IoT Edge című témakört.
A IoT Edge ügynök és IoT Edge központ két modul, amelyek a IoT Edge futtatókörnyezetet alkotják. Az egyes futtatókörnyezeti modulok feladatairól további információt a a Azure IoT Edge futtatókörnyezet és architektúrája című témakörben talál.
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: tanulja meg, hogyan helyezhet üzembe modulokat, és hogyan hozhat létre útvonalakat IoT Edge.
A modul ikermodulja a következőket tartalmazza:
Kívánt tulajdonságok. A megoldás háttérrendszere beállítja a kívánt tulajdonságokat, és a modul felolvassa őket. A modul értesítést is kap a kívánt tulajdonságok változásairól. A modul konfigurációjának vagy feltételeinek szinkronizálásához használja a kívánt tulajdonságokat és a jelentett tulajdonságokat.
Jelentett tulajdonságok. A modul beállítja a jelentett tulajdonságokat, és a megoldás háttérrendszere beolvassa és lekérdezi őket. A modulkonfiguráció vagy -feltételek szinkronizálásához használja a jelentett tulajdonságokat és a kívánt tulajdonságokat.
EdgeAgent kívánt tulajdonságok
A IoT Edge-ügynök moduljának neve $edgeAgent. Koordinálja az eszközön futó IoT Edge ügynök és IoT Hub közötti kommunikációt. Állítsa be a kívánt tulajdonságokat, ha egy adott eszközön egy egyszeri vagy nagy léptékű üzembe helyezés részeként alkalmaz üzembehelyezési jegyzékfájlt.
| Tulajdonság | Leírás | Kötelező |
|---|---|---|
imagePullPolicy |
Megadja, hogy mikor kell lekérni a képet: OnCreate vagy Never. Válassza a Soha lehetőséget, 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, sikertelenség esetén: indítsa újra a modult, ha nem nulla kilépési kóddal lép ki, nem egészséges: indítsa újra a modult, ha nem kifogástalan (lásd megjegyzés), mindig: mindig indítsa újra a modult, ha nem fut.
Megjegyzés: A on-failure szabályzat újraindítja a nem nulla kilépési kóddal kilépő modulokat. A on-unhealthy séma elfogadja a szabályzatot, de a futtatókörnyezet jelenleg nem a Docker állapot-ellenőrzéseiből származtat kifogástalan állapotot, így nincs gyakorlati hatása. Részletekért lásd: IoT Edge korlátozások és korlátozások. |
Igen |
runtime.type |
Docker legyen. | Igen |
runtime.settings.minDockerVersion |
Meghatározza az üzembehelyezési jegyzék által megkövetelt minimális Docker-verziót. | Igen |
runtime.settings.loggingOptions |
Megad egy karakterláncként formázott JSON-t, amely az IoT Edge ügynök konténer naplózási beállításait tartalmazza. További információ a Docker naplózási lehetőségeiről. | Nem |
runtime.settings.registryCredentials.{registryId}.username |
Megadja a tárolóregisztrációs adatbázis felhasználónevét. Az Azure Container Registry esetében a felhasználónév általában a registry neve. Privát modul képeihez regisztrációs hitelesítő adatok 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. A Azure Container Registry esetében a cím általában {registry name}.azurecr.io. |
Nem |
schemaVersion |
Az 1.0-s vagy az 1.1-et adja meg. A IoT Edge 1.0.10-es verziójával bevezetett 1.1-es verzió ajánlott. | Igen |
status |
A modul kívánt állapota: Futtatás vagy leállítás. | Kötelező |
systemModules.edgeAgent.type |
Docker legyen. | Igen |
systemModules.edgeAgent.startupOrder |
Egy egész számot ad meg a modul indítási sorrendben elfoglalt pozíciójához. A 0 az első, a maximális egész szám (4294967295) pedig az utolsó. Ha nem ad meg értéket, az alapértelmezett érték a maximális egész szám. | Nem |
systemModules.edgeAgent.settings.image |
A IoT Edge ügynök képének URI-ját adja meg. A IoT Edge ügynök nem tudja frissíteni magát. | Igen |
systemModules.edgeAgent.settings.createOptions |
Sztringezett JSON-t ad meg a IoT Edge ügynöktároló létrehozásának lehetőségeivel. További információ a Docker létrehozási lehetőségeiről. | Nem |
systemModules.edgeAgent.configuration.id |
Az üzembe helyezés azonosítója, amely modult telepített. | IoT Hub beállítja ezt a tulajdonságot, amikor a jegyzékfájlt üzembe helyezéssel alkalmazza. Nem része az üzembehelyezési jegyzéknek. |
systemModules.edgeHub.type |
Docker legyen. | Igen |
systemModules.edgeHub.status |
Futnia kell. | Igen |
systemModules.edgeHub.restartPolicy |
Mindig az kell legyen. | Igen |
systemModules.edgeHub.startupOrder |
Egy egész szám, amely megadja, hogy egy modul milyen helyen van az indítási sorrendben. A 0 az első, a maximális egész szám (4294967295) pedig az utolsó. Ha nem ad meg értéket, az alapértelmezett érték a maximális egész szám. | Nem |
systemModules.edgeHub.settings.image |
A IoT Edge hub képének URI-ja. | Igen |
systemModules.edgeHub.settings.createOptions |
Sztringezett JSON, amely a IoT Edge hubtároló létrehozásának lehetőségeit tartalmazza. A Docker létrehozási lehetőségei | Nem |
systemModules.edgeHub.configuration.id |
Az üzembe helyezés azonosítója, amely modult telepített. | IoT Hub beállítja ezt a tulajdonságot, amikor a jegyzékfájlt üzembe helyezéssel alkalmazza. Nem része az üzembehelyezési jegyzéknek. |
modules.{moduleId}.version |
A modul verzióját képviselő, felhasználó által definiált sztring. | Igen |
modules.{moduleId}.type |
Docker legyen. | Igen |
modules.{moduleId}.status |
Futás | Megállt | Igen |
modules.{moduleId}.restartPolicy |
Soha nem | hiba esetén | nem megfelelő állapotban | Mindig | Igen |
modules.{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 nem ad meg értéket, az alapértelmezett érték a maximális egész szám. | Nem |
modules.{moduleId}.imagePullPolicy |
létrehozás | utánSoha nem | Nem |
modules.{moduleId}.env |
A modulnak átadni kívánt környezeti változók listája. A formátumot "<name>": {"value": "<value>"}veszi fel. |
Nem |
modules.{moduleId}.settings.image |
A modul képének URI-ja. | Igen |
modules.{moduleId}.settings.createOptions |
Sztringezett JSON, amely a modultároló létrehozásának lehetőségeit tartalmazza. A Docker létrehozási lehetőségei | Nem |
modules.{moduleId}.configuration.id |
Az üzembe helyezés azonosítója, amely modult telepített. | IoT Hub beállítja ezt a tulajdonságot, amikor a jegyzékfájlt üzembe helyezéssel alkalmazza. Nem része az üzembehelyezési jegyzéknek. |
version |
Az aktuális iteráció, amely verzióval, véglegesítéssel és buildeléssel rendelkezik. | Nem |
EdgeAgent jelentett tulajdonságok
IoT Edge ügynök által jelentett tulajdonságok 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 által jelentett módon, és
- Az eszközön jelenleg futó kívánt tulajdonságok másolása.
Az aktuális kívánt tulajdonságok másolata segít megállapítani, hogy az eszköz a legújabb üzembe helyezést alkalmazta-e, vagy továbbra is futtat egy korábbi üzembe helyezési jegyzéket.
Feljegyzés
Az IoT Edge ügynök által jelentett tulajdonságokat a IoT Hub lekérdezési nyelv használatával kérdezheti le a központi telepítés állapotának nagy méretekben történő vizsgálatához. További információért arról, hogyan használhatja az IoT Edge ügynök tulajdonságait az állapot meghatározásához, tekintse meg az Az IoT Edge üzembe helyezések megértése egyedi eszközök esetén vagy nagy léptékben című részt.
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 |
Az IoT Edge ügynök által utoljára látott kívánt tulajdonságok állapotkódja. 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 a IoT Edge ügynök által feldolgozott kívánt tulajdonságok utolsó verziójára hivatkozik. |
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úra 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 |
A IoT Edge ügynök jelentett állapotának szöveges leírása. |
systemModules.edgeAgent.exitCode |
A 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 központ állapota: { fut | megállt | sikertelen | várakozás | egészségtelen }. |
systemModules.edgeHub.statusDescription |
A IoT Edge központ állapotának szöveges leírása, ha nem megfelelő. |
systemModules.edgeHub.exitCode |
A IoT Edge központi tá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 |
A IoT Edge hub utolsó újraindításának időpontja. |
systemModules.edgeHub.restartCount |
Hányszor indult újra ez a modul az újraindítási szabályzat részeként? |
modules.{moduleId}.runtimeStatus |
A modul állapota: { fut | leállítva | sikertelen | visszavonuló | egészségtelen }. |
modules.{moduleId}.statusDescription |
A modul állapotának szöveges leírása, ha nem megfelelő. |
modules.{moduleId}.exitCode |
A modultároló által jelentett kilépési kód, ha a tároló kilép. |
modules.{moduleId}.lastStartTimeUtc |
A modul utolsó indításának időpontja. |
modules.{moduleId}.lastExitTimeUtc |
A modul utolsó kilépésének időpontja. |
modules.{moduleId}.lastRestartTimeUtc |
A modul utolsó újraindításának időpontja. |
modules.{moduleId}.restartCount |
Hányszor indult újra ez a modul az újraindítási szabályzat részeként? |
version |
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 ikermodulját $edgeHub-nak nevezik. Koordinálja az eszközön futó IoT Edge központ és a IoT Hub közötti kommunikációt. Állítsa be a kívánt tulajdonságokat, ha egy adott eszközön egy egyszeri vagy nagy léptékű üzembe helyezés részeként alkalmaz üzembehelyezési jegyzékfájlt.
| Tulajdonság | Leírás | Az üzembehelyezési jegyzékben kötelező megadni |
|---|---|---|
schemaVersion |
1.0 vagy 1.1. Az 1.1-es verzió IoT Edge 1.0.10-es verzióval lett bevezetve, és ajánlott. | Igen |
routes.{routeName} |
Egy IoT Edge hub útvonalát jelképező karakterlánc. További információ: Útvonalak deklarálása. | Az routes elem jelen lehet, de üres. |
storeAndForwardConfiguration.timeToLiveSecs |
A IoT Edge központ által az útválasztási végpontokról leválasztott üzeneteket az eszköz másodpercek alatt megőrzi, függetlenül attól, hogy IoT Hub vagy helyi modulról van-e szó. 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 a IoT Edge hub által feldolgozott kívánt tulajdonságok utolsó verzióját jelenti. |
lastDesiredStatus.code |
A IoT Edge hub á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. |
clients |
Az edgeHubhoz az állapottal és az utolsó kapcsolódási időponttal csatlakozó összes ügyfél. Példa: "clients": { "device2/SimulatedTemperatureSensor": { "status": "Connected", "lastConnectedTimeUtc": "2022-11-17T21:49:16.4781564Z" } }. A tulajdonságban szereplő kapcsolatokról további információt a Melyik kapcsolatok jelennek meg a tulajdonságban clients. |
clients.{device or moduleId}.status |
Az eszköz vagy modul kapcsolati állapota. Lehetséges értékek: csatlakoztatva vagy leválasztva. Csak a modulidentitások lehetnek leválasztott állapotban. A IoT Edge hubhoz csatlakozó alsóbb rétegbeli eszközök csak csatlakozáskor jelennek meg. |
clients.{device or moduleId}.lastConnectTime |
Az eszköz vagy modul legutóbbi csatlakoztatása. |
clients.{device or moduleId}.lastDisconnectTime |
Legutóbb az eszközt vagy modult leválasztották. |
schemaVersion |
A jelentett tulajdonságok sémaverziója. |
version |
A kép verziója. Például: "version": { "version": "1.2.7", "build": "50979330", "commit": "d3ec971caa0af0fc39d2c1f91aef21e95bd0c03c" }. |
Mely kapcsolatok jelennek meg a következőben: clients
A clients jelentett tulajdonság felsorolja a helyi edgeHub által kiszolgált minden különálló logikai kapcsolatot, kivéve a saját $edgeHub identitását. Specifically:
-
Az azonos peremeszközön lévő modulok a következőképpen
<deviceId>/<moduleName>jelennek meg: . Ebbe beletartozik az is$edgeAgent, hogy a helyi edgeAgent a helyi edgeHubon keresztül csatlakozik. -
Downstream IoT Edge gyermekeszközök
<childDeviceId>/$edgeHubés<childDeviceId>/$edgeAgentformájában jelennek meg. Nincs sima<childDeviceId>bejegyzés. A gyermek$edgeHubkapcsolata az átjáróhierarchiában található csatlakoztatott ügyfelek számában hivatkozott "eszköz saját kapcsolata". -
Downstream levéleszközök (nem IoT Edge eszközök)
<deviceId>ként jelennek meg modul utótag nélkül. - A helyi edgeHub saját identitása (
<deviceId>/$edgeHub) szándékosan hiányzik az önhivatkozás elkerülése érdekében.
Amikor egy modul lekapcsolódik, a bejegyzése a(z) clients elemben marad, Disconnected állapottal. Amikor egy alárendelt eszköz leválik, a bejegyzése eltávolításra kerül a(z) clients elemből. A látható bejegyzések száma megegyezik a(z) MaxConnectedClients-hoz tervezett darabszámmal. Nincs rejtett további kapcsolat.
Következő lépések
További információ arról, hogyan használhatja ezeket a tulajdonságokat az üzembehelyezési jegyzékek összeállításához: A IoT Edge modulok használatának, konfigurálásának és újrafelhasználásának módjáról.