az iot edge deployment
Feljegyzés
Ez a hivatkozás az Azure CLI azure-iot bővítményének része (2.46.0-s vagy újabb verzió). A bővítmény automatikusan telepíti az az iot edge üzembe helyezési parancs első futtatásakor. További információ a bővítményekről.
Az IoT Edge-környezetek nagy léptékű kezelése.
Parancsok
Name | Description | Típus | Állapot |
---|---|---|---|
az iot edge deployment create |
Hozzon létre egy IoT Edge-üzembe helyezést egy cél IoT Hubon. |
Mellék | FE |
az iot edge deployment delete |
IoT Edge-telepítés törlése. |
Mellék | FE |
az iot edge deployment list |
IoT Edge-példányok listázása egy IoT Hubon. |
Mellék | FE |
az iot edge deployment show |
Az IoT Edge-telepítés részleteinek lekérése. |
Mellék | FE |
az iot edge deployment show-metric |
Értékelje ki az IoT Edge-üzemelő példányban definiált célrendszermetrikát. |
Mellék | FE |
az iot edge deployment update |
Az IoT Edge-környezet megadott tulajdonságainak frissítése. |
Mellék | FE |
az iot edge deployment create
Hozzon létre egy IoT Edge-üzembe helyezést egy cél IoT Hubon.
Az üzembehelyezési tartalom json, és {"modulesContent":{...}} vagy {"content":{"modulesContent":{...}}}.
Alapértelmezés szerint a rendszermodulok $edgeAgent és $edgeHub tulajdonságai az IoT-bővítménnyel telepített sémákon vannak érvényesítve. Ez az ellenőrzés alaptelepítésekhez készült. Ha a megfelelő séma nem érhető el, vagy az alaptelepítési formátum nem észlelhető, a rendszer kihagyja ezt a lépést. A sémaérvényesítés a --no-validation kapcsolóval tiltható le.
A peremhálózati üzembe helyezés rétegzettként van besorolva, ha egy modul rendelkezik properties.desired.* definícióval. Minden rétegzett üzembe helyezés által megcélzott peremeszköznek először egy alapszintű üzembe helyezésre van szüksége.
Az eszközt célzó rétegzett központi telepítéseknek magasabb prioritással kell rendelkezniük, mint az adott eszköz alaptelepítése.
Megjegyzés: Ha egy modul ikerpéldányának properties.desired mezője réteges üzembe helyezésben van beállítva, a properties.desired felülírja a modul kívánt tulajdonságait minden alacsonyabb prioritású üzembe helyezésnél.
az iot edge deployment create --content
--deployment-id
[--auth-type {key, login}]
[--cl]
[--cmq]
[--hub-name]
[--lab]
[--layered {false, true}]
[--login]
[--metrics]
[--no-validation {false, true}]
[--pri]
[--resource-group]
[--target-condition]
Példák
Hozzon létre egy üzembe helyezést címkékkel (bash szintaxis példája), amely a 9. épületben lévő eszközökre vonatkozik, és a környezet "teszt".
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3
Hozzon létre egy üzembe helyezést címkékkel (powershell-szintaxis példa), amelyek a "dev" környezettel címkézett eszközökre vonatkoznak.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"
Hozzon létre egy rétegzett üzembe helyezést, amely a "dev" környezettel címkézett eszközökre vonatkozik. A felhasználói metrikák és a modulok beágyazottan definiált tartalma (példa PowerShell-szintaxisra). Vegye figyelembe, hogy ez a tulajdonság.desired.* rétegzett üzembe helyezési formátumban van definiálva.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"
Hozzon létre egy rétegzett üzembe helyezést, amely a "9. épület" és a "teszt" környezet eszközeire vonatkozik. A felhasználói metrikák és a modulok beágyazottan definiált tartalma is (példa bash szintaxisra). Vegye figyelembe, hogy ez a tulajdonság.desired.* rétegzett üzembe helyezési formátumban van definiálva.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'
Hozzon létre egy üzembe helyezést, amely a 9. épületben lévő eszközökre és a környezet "teszt" környezetére vonatkozik. A fájlból definiált felhasználói metrikák és modulok tartalma is.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json
Hozzon létre egy olyan üzembe helyezést, amelynek definíciója a címkék és metrikák rendszerhéj-agnosztikus bemenetével rendelkező fájlból származik.
az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"
Kötelező paraméterek
Az IoT Edge üzembehelyezési tartalma. Adja meg a fájl elérési útját vagy a nyers jsont.
Céltelepítés neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].
Opcionális paraméterek
Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>
konfigurálhatja: .
Alternatív beviteli stílus (szóközzel elválasztott kulcs=értékpárok) a --labelshez, és a jövőben szeretné lecserélni. Példa formázása: key1=value1 key2="ez az én értékem".
Alternatív beviteli stílus (szóközzel elválasztott kulcs=értékpárok) a --metrikákhoz, és a jövőben szeretné lecserélni. Példa formázása: metric1="select deviceId from devices where tags.location='US'" metric2="select *".
IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.
A céltelepítésre alkalmazandó címkék térképe. Használja a következő formátumot: "{"key0":"value0", "key1":"value1"}. A --custom-labels használata ajánlott a --labels helyett.
A rétegzett üzemelő példányok lehetővé teszik a kívánt tulajdonságok definiálását $edgeAgent, $edgeHub és felhasználói modulokban, amelyek egy alaptelepítés fölé kerülnek. A rétegzett üzembe helyezésben megadott tulajdonságok egyesülnek az alaptelepítés tulajdonságaival. Az azonos elérési úttal rendelkező tulajdonságok felülíródnak az üzembehelyezési prioritás alapján. Ez a beállítás a --no-validation aliasa.
Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.
Az IoT Edge üzembe helyezésének felhasználói metrikadefiníciói. Adja meg a fájl elérési útját vagy a nyers jsont. A felhasználói metrikák {"lekérdezések":{...}} vagy {"metrics":{"lekérdezések":{...}}}. A --custom-metric-lekérdezések használata ajánlott a --metrics helyett.
Letiltja az ügyféloldali sémaérvényesítést a peremhálózati üzembe helyezés létrehozásához.
Az üzembe helyezés súlya versengő szabályok esetén (a legmagasabb győzelem).
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Célfeltétel, amelyre egy peremhálózati telepítés vonatkozik. A célfeltétel nélküli üzemelő példányok egyetlen eszközt sem céloznak meg. Használja a következő formátumot: "tags.environment='test".
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az iot edge deployment delete
IoT Edge-telepítés törlése.
az iot edge deployment delete --deployment-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
Kötelező paraméterek
Céltelepítés neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].
Opcionális paraméterek
Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>
konfigurálhatja: .
Az erőforrás utolsó állapotának megfelelő etag vagy entitáscímke. Ha nincs megadva etag, a rendszer a "*" értéket használja.
IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.
Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az iot edge deployment list
IoT Edge-példányok listázása egy IoT Hubon.
az iot edge deployment list [--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
Opcionális paraméterek
Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>
konfigurálhatja: .
IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.
Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
A visszaadni kívánt üzemelő példányok maximális száma. Alapértelmezés szerint a rendszer minden üzembe helyezést visszaad.
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az iot edge deployment show
Az IoT Edge-telepítés részleteinek lekérése.
az iot edge deployment show --deployment-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
Kötelező paraméterek
Céltelepítés neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].
Opcionális paraméterek
Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>
konfigurálhatja: .
IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.
Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az iot edge deployment show-metric
Értékelje ki az IoT Edge-üzemelő példányban definiált célrendszermetrikát.
az iot edge deployment show-metric --deployment-id
--metric-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--metric-type {system, user}]
[--resource-group]
Példák
Az "appliedCount" rendszermetrika kiértékelése
az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system
A "myCustomMetric" felhasználói metrika kiértékelése
az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}
Kötelező paraméterek
Céltelepítés neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].
A kiértékelés célmetrikája.
Opcionális paraméterek
Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>
konfigurálhatja: .
IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.
Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.
Azt jelzi, hogy melyik metrikagyűjteményt kell használni a metrikák kereséséhez.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.
az iot edge deployment update
Az IoT Edge-környezet megadott tulajdonságainak frissítése.
Az üzemelő példány frissítéséhez használja a --set, majd a tulajdonsághozzárendeléseket.
Megjegyzés: Az IoT Edge üzembehelyezési tartalma nem módosítható. A frissíthető üzembehelyezési tulajdonságok a következők: "címkék", "metrikák", "prioritás" és "targetCondition".
az iot edge deployment update --deployment-id
[--add]
[--auth-type {key, login}]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--remove]
[--resource-group]
[--set]
Példák
Meglévő peremhálózati telepítés címkéinek és célfeltételének módosítása
az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'
Kötelező paraméterek
Céltelepítés neve. Kisbetűs és a következő speciális karakterek engedélyezettek: [-+%_*!].
Opcionális paraméterek
Adjon hozzá egy objektumot az objektumok listájához egy elérési út és egy kulcsértékpár megadásával. Példa: --add property.listProperty <key=value, string or JSON string>
Azt jelzi, hogy a műveletnek automatikusan le kell-e származtatnia egy szabályzatkulcsot, vagy az aktuális Azure AD-munkamenetet kell-e használnia. Ha a hitelesítési típus bejelentkezés, és az erőforrás-állomásnév meg van adva, az erőforrás-keresés kihagyva lesz, hacsak nem szükséges. Az alapértelmezett beállítást a következővel az configure --defaults iothub-data-auth-type=<auth-type-value>
konfigurálhatja: .
Az erőforrás utolsó állapotának megfelelő etag vagy entitáscímke. Ha nincs megadva etag, a rendszer a "*" értéket használja.
A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.
IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.
Ez a parancs egy művelet végrehajtására jogosult entitást kapcsolati sztring támogat. Az "az login" használatával elkerülheti a munkamenet-bejelentkezést. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring elsőbbséget élvez. Ha a --hub-name nincs megadva, kötelező megadni.
Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove>
VAGY --remove propertyToRemove
.
Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>
: .
Frissítsen egy objektumot egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=<value>
Globális paraméterek
Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.
Jelenítse meg ezt a súgóüzenetet, és lépjen ki.
Csak a hibák megjelenítése, a figyelmeztetések mellőzése.
Kimeneti formátum.
JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .
Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID
: .
A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.