az iot hub job

Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia azure-iot dla interfejsu wiersza polecenia platformy Azure (wersja 2.30.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az iot hub job . Dowiedz się więcej o rozszerzeniach.

Zarządzanie zadaniami IoT Hub (wersja 2).

Polecenia

az iot hub job cancel	Anuluj zadanie IoT Hub.
az iot hub job create	Utwórz i zaplanuj zadanie IoT Hub do wykonania.
az iot hub job list	Wyświetl listę zadań historycznych IoT Hub.
az iot hub job show	Pokaż szczegóły istniejącego zadania IoT Hub.

az iot hub job cancel

Anuluj zadanie IoT Hub.

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

Przykłady

Anuluj zadanie IoT Hub.

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

Parametry wymagane

--job-id

IoT Hub identyfikator zadania.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie uzyskać klucz zasad, czy użyć bieżącej sesji Azure AD. Wartość domyślną można skonfigurować przy użyciu polecenia az configure --defaults iothub-data-auth-type=<auth-type-value>.

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

To polecenie obsługuje parametry połączenia jednostki z prawami do wykonania akcji. Użyj polecenia , aby uniknąć logowania sesji za pomocą polecenia "az login". Jeśli parametry połączenia jednostki i nazwa są podane parametry połączenia mają priorytet. Wymagane, jeśli nie podano nazwy --hub-name.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub job create

Utwórz i zaplanuj zadanie IoT Hub do wykonania.

Podczas planowania zadania aktualizacji bliźniaczej reprezentacji bliźniaczej poprawka jest wymaganym argumentem. Podczas planowania zadania metody urządzenia wymagane są argumenty nazwy metody i ładunku. UWAGA: Użycie niestandardowego czasu rozpoczęcia, który znajduje się w przeszłości, może spowodować niepowodzenie operacji.

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

Przykłady

Utwórz i zaplanuj zadanie w celu zaktualizowania tagów bliźniaczych wszystkich urządzeń.

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

Zaplanuj zadanie i zablokuj wynik "ukończono", "niepowodzenie" lub "anulowane". Określ interwał sondowania w sekundach.

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

Utwórz zadanie, aby zaktualizować żądaną właściwość bliźniaczej reprezentacji w podzestawie urządzeń, zaplanowane do uruchomienia w dowolnym czasie w przyszłości.

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

Utwórz i zaplanuj zadanie, aby wywołać metodę urządzenia dla zestawu urządzeń spełniających warunek zapytania.

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"

Utwórz i zaplanuj zadanie, aby wywołać metodę urządzenia dla wszystkich urządzeń.

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

Parametry wymagane

--job-id

IoT Hub identyfikator zadania.

--job-type --jt

Typ zaplanowanego zadania.

akceptowane wartości: scheduleDeviceMethod, scheduleUpdateTwin

Parametry opcjonalne

--auth-type

akceptowane wartości: key, login

wartość domyślna: key

--duration --poll-duration

Całkowity czas trwania w sekundach, w którym stan zadania będzie sprawdzany, czy flaga --wait została przekazana.

wartość domyślna: 600

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--interval --poll-interval

Interwał w sekundach, w których stan zadania zostanie sprawdzony, czy zostanie przekazana flaga --wait.

wartość domyślna: 10

--login -l

--mct --method-connect-timeout

Maksymalna liczba sekund oczekiwania na połączenie urządzenia.

wartość domyślna: 30

--method-name --mn

Metoda docelowa wywołania.

--method-payload --mp

Ładunek Json, który ma zostać przekazany do metody. Musi być ścieżką pliku lub nieprzetworzonym plikiem json.

--method-response-timeout --mrt

Maksymalna liczba sekund oczekiwania na wynik metody urządzenia.

wartość domyślna: 30

--patch --twin-patch

Żądana poprawka bliźniaczej reprezentacji. Podaj ścieżkę pliku lub nieprzetworzone dane json.

--query-condition -q

Warunek zapytania dotyczącego urządzenia w celu pobrania urządzeń do wykonania zadania. Wymagane, jeśli typ zadania to scheduleDeviceMethod lub scheduleUpdateTwin. Uwaga: usługa będzie prefiks "SELECT * FROM devices WHERE" do danych wejściowych.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--start --start-time

Zaplanowane rozpoczęcie zadania w formacie godziny daty ISO 8601. Jeśli nie zostanie podany czas rozpoczęcia, zadanie zostanie w kolejce do wykonania asap. Użycie niestandardowego czasu rozpoczęcia, który znajduje się w przeszłości, może spowodować niepowodzenie operacji.

--ttl

Maksymalny czas wykonywania w sekundach przed zakończeniem zadania.

wartość domyślna: 3600

--wait -w

Blokuj, dopóki utworzone zadanie nie zostanie ukończone, zakończone niepowodzeniem lub anulowane. Regularnie sonduje według interwału określonego przez --poll-interval.

akceptowane wartości: false, true

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub job list

Wyświetl listę zadań historycznych 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]

Przykłady

Wyświetl listę wszystkich zarchiwizowanych zadań w okresie przechowywania (maksymalnie 30 dni).

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

Wyświetlanie listy wszystkich zarchiwizowanych zadań projektujących określone właściwości

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

Wyświetlanie listy tylko aktualizacji zadań typu bliźniaczej reprezentacji

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

Wyświetlanie listy zadań metody urządzenia, które mają stan "zaplanowane"

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

Wyświetlanie listy zadań eksportu urządzeń, które mają stan "ukończono"

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

Parametry opcjonalne

--auth-type

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--job-status --js

Stan zaplanowanego zadania.

akceptowane wartości: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown

--job-type --jt

Typ zaplanowanego zadania.

akceptowane wartości: export, import, scheduleDeviceMethod, scheduleUpdateTwin

--login -l

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--top

Maksymalna liczba elementów do zwrócenia. Użyj -1, aby uzyskać nieograniczoną liczbę.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az iot hub job show

Pokaż szczegóły istniejącego zadania IoT Hub.

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

Przykłady

Pokaż szczegóły utworzonego zadania.

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

Parametry wymagane

--job-id

IoT Hub identyfikator zadania.

Parametry opcjonalne

--auth-type

akceptowane wartości: key, login

wartość domyślna: key

--hub-name -n

IoT Hub nazwa. Wymagane, jeśli nie podano --login.

--login -l

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.