az iot central job

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 central job . Dowiedz się więcej o rozszerzeniach.

Zarządzanie i konfigurowanie zadań dla aplikacji usługi IoT Central.

Polecenia

Nazwa	Opis	Typ	Stan
az iot central job create	Utwórz i wykonaj zadanie za pomocą jego definicji zadania.	Numer wewnętrzny	Ogólna dostępność
az iot central job get-devices	Pobieranie stanu urządzenia zadania.	Numer wewnętrzny	Ogólna dostępność
az iot central job list	Pobierz listę zadań dla aplikacji usługi IoT Central.	Numer wewnętrzny	Ogólna dostępność
az iot central job rerun	Uruchom ponownie zadanie na wszystkich urządzeniach, które zakończyły się niepowodzeniem.	Numer wewnętrzny	Ogólna dostępność
az iot central job resume	Wznów zatrzymane zadanie.	Numer wewnętrzny	Ogólna dostępność
az iot central job show	Uzyskaj szczegółowe informacje o zadaniu według identyfikatora.	Numer wewnętrzny	Ogólna dostępność
az iot central job stop	Zatrzymaj uruchomione zadanie.	Numer wewnętrzny	Ogólna dostępność

az iot central job create

Utwórz i wykonaj zadanie za pomocą jego definicji zadania.

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--batch]
                          [--batch-type {number, percentage}]
                          [--cancellation-threshold]
                          [--cancellation-threshold-batch]
                          [--cancellation-threshold-type {number, percentage}]
                          [--central-api-uri]
                          [--desc]
                          [--job-name]
                          [--token]

Przykłady

Tworzenie zadania o nazwie

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath}

Utwórz zadanie o nazwie i konfiguracji wsadowej.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

Utwórz zadanie z konfiguracją progową nazwy i anulowania bez partii.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--content -k

Definicja danych zadania. Podaj ścieżkę do pliku JSON lub nieprzetworzonego ciągu JSON. [Przykład ścieżki pliku:./path/to/file.json] [Przykład ciąguified JSON:[{}]. Treść żądania musi zawierać tablicę JobData.

--group-id -g

Identyfikator grupy urządzeń, na której ma zostać wykonane zadanie.

--job-id -j

Unikatowy identyfikator zadania.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--batch -b

Liczba lub procent urządzeń, na których odbywa się przetwarzanie wsadowe.

--batch-type --bt

Określ, czy przetwarzanie wsadowe odbywa się na wielu urządzeniach, czy na procentach sumy.

akceptowane wartości: number, percentage

wartość domyślna: number

--cancellation-threshold --cth

Liczba lub procent urządzeń, na których jest stosowany próg anulowania.

--cancellation-threshold-batch --ctb

Niezależnie od tego, czy próg anulowania ma zastosowanie do partii, czy do ogólnego zadania.

wartość domyślna: number

--cancellation-threshold-type --ctt

Określ, czy próg anulowania ma zastosowanie dla liczby urządzeń lub procentu sumy.

akceptowane wartości: number, percentage

wartość domyślna: number

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--desc --description

Szczegółowy opis zadania.

--job-name

Nazwa wyświetlana zadania.

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central job get-devices

Pobieranie stanu urządzenia zadania.

az iot central job get-devices --app-id
                               --job-id
                               [--api-version {2022-07-31}]
                               [--central-api-uri]
                               [--token]

Przykłady

Pobieranie listy stanów poszczególnych urządzeń według identyfikatora zadania

az iot central job get-devices --app-id {appid} --job-id {jobId}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--job-id -j

Unikatowy identyfikator zadania.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central job list

Pobierz listę zadań dla aplikacji usługi IoT Central.

az iot central job list --app-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Przykłady

Wyświetlanie listy zadań w aplikacji

az iot central job list --app-id {appid}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central job rerun

Uruchom ponownie zadanie na wszystkich urządzeniach, które zakończyły się niepowodzeniem.

az iot central job rerun --app-id
                         --job-id
                         --rerun-id
                         [--api-version {2022-07-31}]
                         [--central-api-uri]
                         [--token]

Przykłady

Ponowne uruchamianie zadania

az iot central job rerun --app-id {appid} --job-id {jobId} --rerun-id {rerunId}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--job-id -j

Unikatowy identyfikator zadania.

--rerun-id

Unikatowy identyfikator ponownego uruchomienia.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central job resume

Wznów zatrzymane zadanie.

az iot central job resume --app-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--central-api-uri]
                          [--token]

Przykłady

Wznawianie zadania

az iot central job resume --app-id {appid} --job-id {jobId}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--job-id -j

Unikatowy identyfikator zadania.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central job show

Uzyskaj szczegółowe informacje o zadaniu według identyfikatora.

az iot central job show --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Przykłady

Uzyskiwanie szczegółów zadania

az iot central job show --app-id {appid} --job-id {jobId}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--job-id -j

Unikatowy identyfikator zadania.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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 central job stop

Zatrzymaj uruchomione zadanie.

az iot central job stop --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Przykłady

Zatrzymywanie zadania

az iot central job stop --app-id {appid} --job-id {jobId}

Parametry wymagane

--app-id -n

Identyfikator aplikacji usługi IoT Central, którą chcesz zarządzać. Identyfikator aplikacji można znaleźć na stronie "Informacje" dla aplikacji w menu pomocy.

--job-id -j

Unikatowy identyfikator zadania.

Parametry opcjonalne

--api-version --av

Przestarzałe

Argument "api_version" został wycofany i zostanie usunięty w przyszłej wersji.

Wersja interfejsu API dla żądanej operacji.

akceptowane wartości: 2022-07-31

wartość domyślna: 2022-07-31

--central-api-uri --central-dns-suffix

Sufiks DNS usługi IoT Central skojarzony z aplikacją.

wartość domyślna: azureiotcentral.com

--token

Jeśli wolisz przesłać żądanie bez uwierzytelniania w interfejsie wiersza polecenia platformy Azure, możesz określić prawidłowy token użytkownika w celu uwierzytelnienia żądania. Musisz określić typ klucza w ramach żądania. Dowiedz się więcej na https://aka.ms/iotcentraldocsapi.

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.