Delen via

az iot hub job

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie wordt automatisch geïnstalleerd wanneer u een opdracht az iot hub job uitvoert. Meer informatie over extensies.

IoT Hub-taken (v2) beheren.

Opdracht

Name Description Type Status
az iot hub job cancel

Een IoT Hub-taak annuleren.

 Toestel GA
az iot hub job create

Een IoT Hub-taak maken en plannen voor uitvoering.

 Toestel GA
az iot hub job list

Vermeld de historische taken van een IoT Hub.

 Toestel GA
az iot hub job show

Details van een bestaande IoT Hub-taak weergeven.

 Toestel GA

az iot hub job cancel

Een IoT Hub-taak annuleren.

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

Voorbeelden

Een IoT Hub-taak annuleren.

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

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub job create

Een IoT Hub-taak maken en plannen voor uitvoering.

Bij het plannen van een updatetaak voor dubbels is de patch voor dubbels een vereist argument. Bij het plannen van een apparaatmethodetaak zijn de naam en nettolading van de methode vereiste argumenten. LET OP: Als u een aangepaste begintijd gebruikt die zich in het verleden voordeed, kan dit ertoe leiden dat de bewerking mislukt.

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

Een taak maken en plannen om de dubbeltags 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"}}'

Schedule job and block for result of "completed", "failed" or "canceled". Geef het 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 tweelingeigenschap op een subset van apparaten, gepland voor uitvoering op een willekeurig tijdstip in de toekomst.

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

Een taak maken en plannen 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"

Een taak maken en plannen om een apparaatmethode voor alle apparaten aan te roepen.

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

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--duration --poll-duration

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

Default value: 600
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--interval --poll-interval

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

Default value: 10
--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--mct --method-connect-timeout

Maximum aantal seconden dat moet worden gewacht op apparaatverbinding.

Default value: 30
--method-name --mn

Doelmethode voor aanroepen.

--method-payload --mp

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

--method-response-timeout --mrt

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

Default value: 30
--patch --twin-patch

De gewenste dubbel patch. Geef bestandspad of onbewerkte json op.

--query-condition -q

Voorwaarde voor apparaatquery om apparaten te laten uitvoeren waarop de taak moet worden uitgevoerd. Vereist als het taaktype scheduleDeviceMethod of scheduleUpdateTwin is. Opmerking: De service zal het voorvoegsel SELECT * FROM devices WHERE " toevoegen 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

Het geplande begin van de taak in ISO 8601-datum/tijdnotatie. Als er geen begintijd is opgegeven, wordt de taak in de wachtrij geplaatst voor de uitvoering van asap. Als u een aangepaste begintijd gebruikt die zich in het verleden voordeed, kan de bewerking mislukken.

--ttl

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

Default value: 3600
--wait -w

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

Geaccepteerde waarden: false, true
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub job list

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

Alleen taken voor het bijwerken van dubbeltypen weergeven

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

Taken voor apparaatmethoden vermelden die de status 'gepland' hebben

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

Lijst met exporttaken voor apparaten met de status Voltooid

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

Optionele parameters

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--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 entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--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 geretourneerd. Gebruik -1 voor onbeperkt.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot hub job show

Details van een bestaande IoT Hub-taak weergeven.

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

Voorbeelden

De details van een gemaakte taak weergeven.

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

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.