az iot hub job

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 hub feladatparancs első futtatásakor. További információ a bővítményekről.

IoT Hub-feladatok kezelése (v2).

Parancsok

Name	Description	Típus	Állapot
az iot hub job cancel	IoT Hub-feladat megszakítása.	Mellék	FE
az iot hub job create	IoT Hub-feladat létrehozása és ütemezése végrehajtáshoz.	Mellék	FE
az iot hub job list	Az IoT Hub előzményfeladatainak listázása.	Mellék	FE
az iot hub job show	Meglévő IoT Hub-feladat részleteinek megjelenítése.	Mellék	FE

az iot hub job cancel

IoT Hub-feladat megszakítása.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Példák

IoT Hub-feladat megszakítása.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

Kötelező paraméterek

--job-id

IoT Hub-feladat azonosítója.

Opcionális paraméterek

--auth-type

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: .

Elfogadott értékek: key, login

Alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

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.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

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: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub job create

IoT Hub-feladat létrehozása és ütemezése végrehajtáshoz.

Ikerfrissítési feladat ütemezésekor az ikerjavítás kötelező argumentum. Eszközmetódus-feladat ütemezésekor a metódus neve és hasznos adatai kötelező argumentumok. MEGJEGYZÉS: Ha egy korábbi egyéni kezdési időpontot használ, a művelet meghiúsulhat.

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--ttl]
                      [--wait {false, true}]

Példák

Feladat létrehozása és ütemezése az összes eszköz ikercímkéjének frissítéséhez.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

Ütemezze a feladatot és a blokkot a "befejezett", a "sikertelen" vagy a "megszakított" eredményhez. Adja meg a lekérdezési időközt másodpercben.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

Hozzon létre egy feladatot a kívánt ikertulajdonság frissítéséhez az eszközök egy részhalmazán, amely ütemezetten egy tetszőleges későbbi időpontban fut.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

Hozzon létre és ütemezzen egy feladatot, amely meghív egy eszközmetódust egy lekérdezési feltételnek eleget tetső eszközcsoporthoz.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

Hozzon létre és ütemezzen egy feladatot, amely meghív egy eszközmetódust az összes eszközhöz.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

Kötelező paraméterek

--job-id

IoT Hub-feladat azonosítója.

--job-type --jt

Az ütemezett feladat típusa.

Elfogadott értékek: scheduleDeviceMethod, scheduleUpdateTwin

Opcionális paraméterek

--auth-type

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: .

Elfogadott értékek: key, login

Alapértelmezett érték: key

--duration --poll-duration

Teljes időtartam másodpercben, amikor a feladat állapotát ellenőrzi a rendszer, ha a --wait jelölőt átadja a rendszer.

Alapértelmezett érték: 600

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--interval --poll-interval

A feladat állapotának másodpercben megadott időköze, ha a --wait jelző be van-e adva.

Alapértelmezett érték: 10

--login -l

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.

--mct --method-connect-timeout

Az eszközkapcsolaton várakozási idő maximális száma.

Alapértelmezett érték: 30

--method-name --mn

Meghívás célmetódusa.

--method-payload --mp

A metódusnak átadni kívánt Json hasznos adat. Fájl elérési útjának vagy nyers json-nak kell lennie.

--method-response-timeout --mrt

Az eszközmetódus eredményére váró másodpercek maximális száma.

Alapértelmezett érték: 30

--patch --twin-patch

A kívánt ikerjavítás. Adja meg a fájl elérési útját vagy a nyers jsont.

--query-condition -q

Az eszköz lekérdezésének feltétele, hogy az eszközök végrehajtják a feladatot. Kötelező, ha a feladat típusa scheduleDeviceMethod vagy scheduleUpdateTwin. Megjegyzés: A szolgáltatás a "SELECT * FROM DEVICES WHERE" előtagot a bemenethez fogja adni.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--start --start-time

A feladat ütemezett kezdete ISO 8601 dátum időformátumban. Ha nincs megadva kezdési idő, a feladat várólistára kerül az asap-végrehajtáshoz. Ha egy korábbi egyéni kezdési időpontot használ, a művelet meghiúsulhat.

--ttl

Maximális végrehajtási idő másodpercben, a feladat leállása előtt.

Alapértelmezett érték: 3600

--wait -w

Tiltsa le, amíg a létrehozott feladat befejeződött, meghiúsult vagy megszakított állapotba nem kerül. Rendszeresen lekérdezi a --poll-interval által megadott időközt.

Elfogadott értékek: false, true

Alapértelmezett érték: False

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

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: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub job list

Az IoT Hub előzményfeladatainak listázása.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Példák

Az összes archivált feladat listázása megőrzési időn belül (legfeljebb 30 nap).

az iot hub job list --hub-name {iothub_name}

Az összes archivált feladat listázása adott tulajdonságok kivetítésével

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Csak ikertípusú feladatok listázása

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Az "ütemezett" állapotú eszközmetódus-feladatok listázása

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

"Befejezett" állapotú eszközexportálási feladatok listázása

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

Opcionális paraméterek

--auth-type

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: .

Elfogadott értékek: key, login

Alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--job-status --js

Ütemezett feladat állapota.

Elfogadott értékek: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown

--job-type --jt

Az ütemezett feladat típusa.

Elfogadott értékek: export, import, scheduleDeviceMethod, scheduleUpdateTwin

--login -l

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.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--top

A visszaadandó elemek maximális száma. Használja a -1-et korlátlanul.

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

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: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub job show

Meglévő IoT Hub-feladat részleteinek megjelenítése.

az iot hub job show --job-id
                    [--auth-type {key, login}]
                    [--hub-name]
                    [--login]
                    [--resource-group]

Példák

Egy létrehozott feladat részleteinek megjelenítése.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

Kötelező paraméterek

--job-id

IoT Hub-feladat azonosítója.

Opcionális paraméterek

--auth-type

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: .

Elfogadott értékek: key, login

Alapértelmezett érték: key

--hub-name -n

IoT Hub neve vagy állomásneve. Kötelező, ha a --login nincs megadva.

--login -l

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.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek

--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

Elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc

Alapértelmezett érték: json

--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

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: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.