az iot hub job

Notitie

Deze referentie maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de opdracht az iot hub job de eerste keer hebt uitgevoerd. Meer informatie over extensies.

Beheer IoT Hub taken (v2).

Opdracht

az iot hub job cancel

Annuleer een IoT Hub taak.

az iot hub job create

Maak en plan een IoT Hub taak voor uitvoering.

az iot hub job list

De historische taken van een IoT Hub.

az iot hub job show

Details van een bestaande IoT Hub taak.

az iot hub job cancel

Annuleer een IoT Hub taak.

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

Voorbeelden

Annuleer een IoT Hub taak.

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

Vereiste parameters

--job-id

IoT Hub taak-id.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

az iot hub job create

Maak en plan een IoT Hub taak voor uitvoering.

Bij het plannen van een dubbelupdate-taak is de dubbele patch een vereist argument. Bij het plannen van een taak voor de apparaatmethode zijn de naam van de methode en de nettolading vereiste argumenten.

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

Voorbeelden

Maak en plan een taak om de dubbele tags van alle apparaten bij te werken.

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

Plan de taak en blokkeer deze voor het resultaat 'voltooid', 'mislukt' of 'geannuleerd'. Geef poll-interval in seconden op.

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

Maak een taak voor het bijwerken van een gewenste tweeling-eigenschap op een subset van apparaten, gepland om op een willekeurig toekomstig tijdstip te worden uitgevoerd.

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

Maak en plan een taak om een apparaatmethode aan te roepen voor een set apparaten die voldoen aan een queryvoorwaarde.

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"

Maak en plan een taak voor het aanroepen van een apparaatmethode voor alle apparaten.

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

Vereiste parameters

--job-id

IoT Hub taak-id.

--job-type --jt

Het type geplande taak.

geaccepteerde waarden: scheduleDeviceMethod, scheduleUpdateTwin

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--duration --poll-duration

Totale duur in seconden waarin de taakstatus wordt gecontroleerd als de vlag --wait wordt doorgegeven.

standaardwaarde: 600
--hub-name -n

IoT Hub naam.

--interval --poll-interval

Interval in seconden dat de taakstatus wordt gecontroleerd als de vlag --wait wordt doorgegeven.

standaardwaarde: 10
--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--mct --method-connect-timeout

Maximum aantal seconden dat moet worden gewacht op de apparaatverbinding.

standaardwaarde: 30
--method-name --mn

Doelmethode voor aanroepen.

--method-payload --mp

Json-nettolading die moet worden doorgegeven aan de methode . Moet bestandspad of onbewerkte json zijn.

--method-response-timeout --mrt

Maximum aantal seconden dat moet worden gewacht op het resultaat van de apparaatmethode.

standaardwaarde: 30
--patch --twin-patch

De gewenste tweelingpatch. Geef het bestandspad of onbewerkte json op.

--query-condition -q

Voorwaarde voor apparaatquery's om apparaten de taak te laten uitvoeren. Vereist als het taaktype scheduleDeviceMethod of scheduleUpdateTwin is. Opmerking: De service voorvoegt 'SELECT * FROM devices WHERE' aan de invoer.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--start --start-time

De geplande start van de taak in ISO 8601 datum/tijd-indeling. Als er geen begintijd is opgegeven, wordt de taak in de wachtrij geplaatst om zo snel mogelijk te worden uitgevoerd.

--ttl

Maximale uitvoeringstijd in seconden, voordat de taak wordt beëindigd.

standaardwaarde: 3600
--wait -w

Blokkeren totdat de gemaakte taak de status Voltooid, Mislukt of Geannuleerd heeft. Pollt regelmatig op basis van het interval dat is opgegeven door --poll-interval.

geaccepteerde waarden: false, true

az iot hub job list

De historische taken van een 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]

Voorbeelden

Vermeld alle gearchiveerde taken binnen de bewaarperiode (maximaal 30 dagen).

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

Alle gearchiveerde taken weergeven die specifieke eigenschappen projecteren

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

Taken van het type Alleen bijwerken van tweelingen

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

Apparaatmethodetaken weergeven met de status 'gepland'

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

Exporttaken van apparaten weergeven met de status 'voltooid'

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

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--job-status --js

De status van een geplande taak.

geaccepteerde waarden: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Het type geplande taak.

geaccepteerde waarden: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .

--top

Maximum aantal elementen dat moet worden retourneren. Gebruik -1 voor onbeperkt.

az iot hub job show

Details van een bestaande IoT Hub taak.

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

Voorbeelden

De details van een gemaakte taak tonen.

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

Vereiste parameters

--job-id

IoT Hub taak-id.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .