az iot hub job

  • Odwołanie

Uwaga

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

Zarządzanie zadaniami usługi IoT Hub (wersja 2).

Polecenia

Nazwa Opis Typ Stan
az iot hub job cancel

Anulowanie zadania usługi IoT Hub.

 Numer wewnętrzny Ogólna dostępność
az iot hub job create

Tworzenie i planowanie zadania usługi IoT Hub na potrzeby wykonywania.

 Numer wewnętrzny Ogólna dostępność
az iot hub job list

Wyświetlanie listy zadań historycznych usługi IoT Hub.

 Numer wewnętrzny Ogólna dostępność
az iot hub job show

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

 Numer wewnętrzny Ogólna dostępność

az iot hub job cancel

Anulowanie zadania usługi IoT Hub.

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

Przykłady

Anulowanie zadania usługi IoT Hub.

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

Parametry wymagane

--job-id

Identyfikator zadania usługi IoT Hub.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. 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

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot hub job create

Tworzenie i planowanie zadania usługi IoT Hub na potrzeby wykonywania.

Podczas planowania zadania aktualizacji bliźniaczej reprezentacji bliźniaczej poprawka jest wymaganym argumentem. Podczas planowania zadania metody urządzenia nazwa metody i ładunek są wymagane argumenty. 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 reprezentacji 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 "completed", "failed" lub "cancelled". 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 w celu zaktualizowania żądanej właściwości bliźniaczej w podzestawie urządzeń, które ma być uruchamiane 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 wywoływania metody 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 wywoływania metody 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

Identyfikator zadania usługi IoT Hub.

--job-type --jt

Typ zaplanowanego zadania.

akceptowane wartości: scheduleDeviceMethod, scheduleUpdateTwin

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. 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
--duration --poll-duration

Łączny czas trwania w sekundach, w których stan zadania będzie sprawdzany, czy flaga --wait została przekazana.

wartość domyślna: 600
--hub-name -n

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--interval --poll-interval

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

wartość domyślna: 10
--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

--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 daty i godziny ISO 8601. Jeśli nie podano czasu rozpoczęcia, zadanie jest kolejkowane do wykonywania 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. Będzie regularnie sondował według interwału określonego przez --poll-interval.

akceptowane wartości: false, true
wartość domyślna: False
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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot hub job list

Wyświetlanie listy zadań historycznych usługi 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]"

Lista aktualizuje tylko zadania 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

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. 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

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --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

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --hub-name.

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

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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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

az iot hub job show

Pokaż szczegóły istniejącego zadania usługi 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

Identyfikator zadania usługi IoT Hub.

Parametry opcjonalne

--auth-type

Wskazuje, czy operacja powinna automatycznie utworzyć klucz zasad, czy użyć bieżącej sesji usługi Azure AD. Jeśli typ uwierzytelniania to identyfikator logowania i zostanie podana nazwa hosta zasobu, wyszukiwanie zasobów zostanie pominięte, chyba że będzie to konieczne. 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

Nazwa lub nazwa hosta usługi IoT Hub. Wymagane, jeśli nie podano opcji --login.

--login -l

To polecenie obsługuje jednostkę parametry połączenia z uprawnieniami do wykonania akcji. Użyj polecenia , aby uniknąć logowania do sesji za pomocą polecenia "az login". Jeśli zarówno jednostka parametry połączenia, jak i nazwa są podane, parametry połączenia ma priorytet. Wymagane, jeśli nie podano --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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

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