Dela via

az iot hub job

  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot hub-jobbkommando . Läs mer om tillägg.

Hantera IoT Hub-jobb (v2).

Kommandon

Name Description Typ Status
az iot hub job cancel

Avbryt ett IoT Hub-jobb.

 Anknytning Allmän tillgänglighet
az iot hub job create

Skapa och schemalägga ett IoT Hub-jobb för körning.

 Anknytning Allmän tillgänglighet
az iot hub job list

Visa en lista över historiska jobb för en IoT Hub.

 Anknytning Allmän tillgänglighet
az iot hub job show

Visa information om ett befintligt IoT Hub-jobb.

 Anknytning Allmän tillgänglighet

az iot hub job cancel

Avbryt ett IoT Hub-jobb.

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

Exempel

Avbryt ett IoT Hub-jobb.

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

Obligatoriska parametrar

--job-id

IoT Hub-jobb-ID.

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

accepterade värden: key, login
standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub job create

Skapa och schemalägga ett IoT Hub-jobb för körning.

När du schemalägger ett tvillinguppdateringsjobb är tvillingkorrigeringen ett obligatoriskt argument. När du schemalägger ett enhetsmetodjobb krävs argumenten för metodnamnet och nyttolasten. Obs! Om du använder en anpassad starttid som tidigare kan åtgärden misslyckas.

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}]

Exempel

Skapa och schemalägga ett jobb för att uppdatera tvillingtaggar för alla enheter.

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

Schemalägg jobb och blockera för resultatet av "slutförd", "misslyckad" eller "avbruten". Ange avsökningsintervall i sekunder.

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

Skapa ett jobb för att uppdatera en önskad tvillingegenskap på en delmängd enheter som är schemalagd att köras vid en godtycklig framtida tidpunkt.

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']"

Skapa och schemalägga ett jobb för att anropa en enhetsmetod för en uppsättning enheter som uppfyller ett frågevillkor.

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"

Skapa och schemalägga ett jobb för att anropa en enhetsmetod för alla enheter.

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

Obligatoriska parametrar

--job-id

IoT Hub-jobb-ID.

--job-type --jt

Typ av schemalagt jobb.

accepterade värden: scheduleDeviceMethod, scheduleUpdateTwin

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

accepterade värden: key, login
standardvärde: key
--duration --poll-duration

Total varaktighet i sekunder där jobbstatusen kontrolleras om --wait-flaggan skickas.

standardvärde: 600
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--interval --poll-interval

Intervall i sekunder som jobbstatusen kontrolleras om --wait-flaggan skickas in.

standardvärde: 10
--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--mct --method-connect-timeout

Maximalt antal sekunder att vänta på enhetsanslutningen.

standardvärde: 30
--method-name --mn

Målmetod för anrop.

--method-payload --mp

Json-nyttolast som ska skickas till metoden. Måste vara filsökväg eller rå json.

--method-response-timeout --mrt

Maximalt antal sekunder att vänta på resultatet av enhetsmetoden.

standardvärde: 30
--patch --twin-patch

Önskad tvillingkorrigering. Ange filsökväg eller rå json.

--query-condition -q

Villkor för enhetsfråga för att få enheter att köra jobbet på. Krävs om jobbtypen är scheduleDeviceMethod eller scheduleUpdateTwin. Obs! Tjänsten kommer att prefixet "SELECT * FROM devices WHERE" till indata.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--start --start-time

Den schemalagda starten av jobbet i ISO 8601-datumtidsformat. Om ingen starttid anges placeras jobbet i kö för asap-körning. Om du använder en anpassad starttid som tidigare kan åtgärden misslyckas.

--ttl

Maximal körningstid i sekunder, innan jobbet avslutas.

standardvärde: 3600
--wait -w

Blockera tills det skapade jobbet har slutförts, misslyckats eller avbrutits. Avsöker regelbundet det intervall som anges av --poll-interval.

accepterade värden: false, true
standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub job list

Visa en lista över historiska jobb för en IoT Hub.

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]

Exempel

Visa en lista över alla arkiverade jobb inom kvarhållningsperioden (högst 30 dagar).

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

Visa en lista över alla arkiverade jobb som projicerar specifika egenskaper

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

Visa endast uppdateringsjobb av tvillingtyp

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

Lista enhetsmetodjobb som har statusen "schemalagd"

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

Lista enhetsexportjobb som har statusen "slutförd"

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

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

accepterade värden: key, login
standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--job-status --js

Status för ett schemalagt jobb.

accepterade värden: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Typ av schemalagt jobb.

accepterade värden: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--top

Maximalt antal element som ska returneras. Använd -1 för obegränsat.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot hub job show

Visa information om ett befintligt IoT Hub-jobb.

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

Exempel

Visa information om ett skapat jobb.

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

Obligatoriska parametrar

--job-id

IoT Hub-jobb-ID.

Valfria parametrar

--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

accepterade värden: key, login
standardvärde: key
--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.