az iot hub job

Megjegyzés

Ez a hivatkozás az Azure CLI Azure-iot bővítményének része (2.30.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

az iot hub job cancel	IoT Hub feladat megszakítása.
az iot hub job create	IoT Hub feladat létrehozása és ütemezése végrehajtásra.
az iot hub job list	Egy IoT Hub előzményfeladatainak listázása.
az iot hub job show	Meglévő IoT Hub feladat részleteinek megjelenítése.

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 feladatazonosító.

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. Az alapértelmezett beállításokat a használatával 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 nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. 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ásra.

Ikerpéldány-frissí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ék 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"}}'

Feladat és blokk ütemezése "befejezve", "sikertelen" vagy "megszakítva" eredményre. 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 egy kívánt ikertulajdonság frissítéséhez az eszközök egy részhalmazán, amely ütemezetten egy tetszőleges jövőbeli időpontban fog futni.

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 egy eszközmetódus meghívásához egy lekérdezési feltételnek eleget tetső eszközkészlethez.

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 feladatazonosító.

--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. Az alapértelmezett beállításokat a használatával 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 rendszer ellenőrzi a feladat állapotát, ha a --wait jelző át van adva.

alapértelmezett érték: 600

--hub-name -n

IoT Hub nevet. Kötelező, ha a --login nincs megadva.

--interval --poll-interval

A feladat állapotának ellenőrzése másodpercben, ha a --wait jelző átadása megtörtént.

alapértelmezett érték: 10

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--mct --method-connect-timeout

Az eszközkapcsolatra való várakozás maximális száma másodpercben.

alapértelmezett érték: 30

--method-name --mn

A meghívás célmetódusa.

--method-payload --mp

A metódusnak átadandó JSON-hasznos adat. Fájlelérési útnak 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 JSON-t.

--query-condition -q

Az eszköz lekérdezésének feltétele a feladat végrehajtásához szükséges eszközök lekéréséhez. 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 a használatával az configure --defaults group=<name>konfigurálhatja.

--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 a végrehajtás során. Ha egy korábbi egyéni kezdési időpontot használ, a művelet meghiúsulhat.

--ttl

A 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 befejezett, sikertelen vagy megszakított állapotba nem kerül. Rendszeresen lekérdezi a --poll-interval által megadott időközt.

elfogadott értékek: false, true

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az iot hub job list

Egy 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 a megőrzési időtartamon 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 ikerpéldány-tí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

"Befejezve" á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. Az alapértelmezett beállításokat a használatával 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 nevet. 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 olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. 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 feladatazonosító.

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. Az alapértelmezett beállításokat a használatával 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 nevet. Kötelező, ha a --login nincs megadva.

--login -l

Ez a parancs olyan entitásokat támogat, kapcsolati sztring műveletek végrehajtásához szükséges jogosultságokkal. Az "az login" használatával történő munkamenet-bejelentkezés elkerülésére használható. Ha egy entitás kapcsolati sztring és név is meg van adva, a kapcsolati sztring prioritást élvez. Kötelező, ha a --hub-name nincs megadva.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a használatával az configure --defaults group=<name>konfigurálhatja.

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.

--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 a használatával az account set -s NAME_OR_IDkonfigurálhatja.

--verbose

Növelje a naplózás részletességét. Használja a --debug parancsot a teljes hibakeresési naplókhoz.