az iot central job

Note

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.67.0 или более поздней). Расширение автоматически установит первый раз, когда вы запускаете команду az iot central job. Подробнее о расширениях.

Управление и настройка заданий для приложения IoT Central.

Команды

Имя Описание Тип Состояние
az iot central job create

Создайте и выполните задание с помощью определения задания.

Extension GA
az iot central job get-devices

Получение состояния устройства задания.

Extension GA
az iot central job list

Получение списка заданий для приложения IoT Central.

Extension GA
az iot central job rerun

Повторное выполнение задания на всех неудачных устройствах.

Extension GA
az iot central job resume

Возобновление остановленного задания.

Extension GA
az iot central job show

Получение сведений о задании по идентификатору.

Extension GA
az iot central job stop

Остановите выполняемое задание.

Extension GA

az iot central job create

Создайте и выполните задание с помощью определения задания.

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--acquire-policy-token]
                          [--api-version --av {2022-07-31}]
                          [--batch]
                          [--batch-type --bt {number, percentage}]
                          [--cancellation-threshold --cth]
                          [--cancellation-threshold-batch --ctb]
                          [--cancellation-threshold-type --ctt {number, percentage}]
                          [--central-api-uri --central-dns-suffix]
                          [--change-reference]
                          [--desc --description]
                          [--job-name]
                          [--token]

Примеры

Создание задания с именем

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

Создайте задание с именем и пакетной конфигурацией.

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

Создайте задание с конфигурацией порогового значения имени и отмены без пакета.

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}

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--content -k

Определение данных задания. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу:./path/to/file.json] [Пример строкифицированного JSON:[{Job Data JSON}]. Текст запроса должен содержать массив JobData.

--group-id -g

Идентификатор группы устройств, в которой выполняется задание.

--job-id -j

Уникальный идентификатор задания.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--batch -b

Число или процент устройств, на которых выполняется пакетная обработка.

--batch-type --bt

Укажите, выполняется ли пакетная обработка на нескольких устройствах или в процентах от общей суммы.

Свойство Значение
Default value: number
Допустимые значения: number, percentage
--cancellation-threshold --cth

Число или процент устройств, на которых применяется порог отмены.

--cancellation-threshold-batch --ctb

Применяется ли порог отмены для каждого пакета или к общему заданию.

Свойство Значение
Default value: number
--cancellation-threshold-type --ctt

Укажите, применяется ли порог отмены для ряда устройств или процента от общего числа устройств.

Свойство Значение
Default value: number
Допустимые значения: number, percentage
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--desc --description

Подробное описание задания.

--job-name

Отображаемое имя задания.

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central job get-devices

Получение состояния устройства задания.

az iot central job get-devices --app-id
                               --job-id
                               [--acquire-policy-token]
                               [--api-version --av {2022-07-31}]
                               [--central-api-uri --central-dns-suffix]
                               [--change-reference]
                               [--token]

Примеры

Получение списка состояний отдельных устройств по идентификатору задания

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--job-id -j

Уникальный идентификатор задания.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central job list

Получение списка заданий для приложения IoT Central.

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

Примеры

Вывод списка заданий в приложении

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central job rerun

Повторное выполнение задания на всех неудачных устройствах.

az iot central job rerun --app-id
                         --job-id
                         --rerun-id
                         [--acquire-policy-token]
                         [--api-version --av {2022-07-31}]
                         [--central-api-uri --central-dns-suffix]
                         [--change-reference]
                         [--token]

Примеры

Повторное выполнение задания

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--job-id -j

Уникальный идентификатор задания.

--rerun-id

Уникальный идентификатор повторного запуска.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central job resume

Возобновление остановленного задания.

az iot central job resume --app-id
                          --job-id
                          [--acquire-policy-token]
                          [--api-version --av {2022-07-31}]
                          [--central-api-uri --central-dns-suffix]
                          [--change-reference]
                          [--token]

Примеры

Возобновление задания

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--job-id -j

Уникальный идентификатор задания.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central job show

Получение сведений о задании по идентификатору.

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

Примеры

Получение сведений о задании

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--job-id -j

Уникальный идентификатор задания.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central job stop

Остановите выполняемое задание.

az iot central job stop --app-id
                        --job-id
                        [--acquire-policy-token]
                        [--api-version --av {2022-07-31}]
                        [--central-api-uri --central-dns-suffix]
                        [--change-reference]
                        [--token]

Примеры

Остановка задания

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

Обязательные параметры

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--job-id -j

Уникальный идентификатор задания.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False