az iot central scheduled-job

Примечание.

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

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

Команды

Имя	Описание	Тип	Состояние
az iot central scheduled-job create	Создайте запланированное задание по идентификатору.	Расширение	Общедоступная версия
az iot central scheduled-job delete	Удалите существующее запланированное задание по идентификатору.	Расширение	Общедоступная версия
az iot central scheduled-job list	Получите список определений запланированных заданий в приложении.	Расширение	Общедоступная версия
az iot central scheduled-job list-runs	Получите список экземпляров заданий для определения запланированного задания.	Расширение	Общедоступная версия
az iot central scheduled-job show	Получение сведений о запланированном задании по идентификатору.	Расширение	Общедоступная версия
az iot central scheduled-job update	Обновите запланированное задание по идентификатору.	Расширение	Общедоступная версия

az iot central scheduled-job create

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

--schedule и --content может быть встроенным json или путь к файлу.

az iot central scheduled-job create --app-id
                                    --content
                                    --group-id
                                    --id
                                    --schedule
                                    [--api-version {2022-06-30-preview, 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]

Примеры

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule {jobScheduleJSONPatch} --content {jobDataJSONPath}

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

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

--app-id -n

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

--content -k

Определение данных задания. Укажите путь к JSON-файлу или необработанным строкам JSON. Текст запроса должен содержать массив JobData.

--group-id -g

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

--id --job-id

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

--schedule

Расписание выполнения задания. Укажите путь к JSON-файлу или необработанным строкам JSON.

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

--api-version --av

Не рекомендуется

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

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

допустимые значения: 2022-06-30-preview, 2022-07-31

значение по умолчанию: 2022-07-31

--batch -b

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

--batch-type --bt

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

допустимые значения: number, percentage

значение по умолчанию: number

--cancellation-threshold --cth

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

--cancellation-threshold-batch --ctb

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

значение по умолчанию: number

--cancellation-threshold-type --ctt

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

допустимые значения: number, percentage

значение по умолчанию: number

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

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

значение по умолчанию: azureiotcentral.com

--desc --description

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

--job-name

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

--token

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

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

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot central scheduled-job delete

Удалите существующее запланированное задание по идентификатору.

az iot central scheduled-job delete --app-id
                                    --id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

Примеры

Удаление существующего запланированного задания по идентификатору

az iot central scheduled-job delete --app-id {appid} --id {scheduledJobId}

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

--app-id -n

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

--id --job-id

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

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

--api-version --av

Не рекомендуется

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

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

допустимые значения: 2022-06-30-preview, 2022-07-31

значение по умолчанию: 2022-07-31

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

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

значение по умолчанию: azureiotcentral.com

--token

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

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

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot central scheduled-job list

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

az iot central scheduled-job list --app-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--token]

Примеры

Получение списка определений запланированных заданий в приложении

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

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

--app-id -n

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

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

--api-version --av

Не рекомендуется

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

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

допустимые значения: 2022-06-30-preview, 2022-07-31

значение по умолчанию: 2022-07-31

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

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

значение по умолчанию: azureiotcentral.com

--token

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

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

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot central scheduled-job list-runs

Получите список экземпляров заданий для определения запланированного задания.

az iot central scheduled-job list-runs --app-id
                                       --id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Примеры

Получение списка экземпляров заданий для определения запланированного задания

az iot central scheduled-job list-runs --app-id {appid} --job-id {jobId}

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

--app-id -n

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

--id --job-id

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

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

--api-version --av

Не рекомендуется

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

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

допустимые значения: 2022-06-30-preview, 2022-07-31

значение по умолчанию: 2022-07-31

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

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

значение по умолчанию: azureiotcentral.com

--token

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

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

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot central scheduled-job show

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

az iot central scheduled-job show --app-id
                                  --id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--token]

Примеры

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

az iot central scheduled-job show --app-id {appid} --id {scheduledJobId}

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

--app-id -n

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

--id --job-id

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

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

--api-version --av

Не рекомендуется

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

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

допустимые значения: 2022-06-30-preview, 2022-07-31

значение по умолчанию: 2022-07-31

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

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

значение по умолчанию: azureiotcentral.com

--token

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

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

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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

az iot central scheduled-job update

Обновите запланированное задание по идентификатору.

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

Примеры

Обновление задания расписания с именем

az iot central scheduled-job update --app-id {appid} --job-id {jobId} --job-name {displayName}

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

--app-id -n

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

--id --job-id

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

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

--api-version --av

Не рекомендуется

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

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

допустимые значения: 2022-06-30-preview, 2022-07-31

значение по умолчанию: 2022-07-31

--batch -b

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

--batch-type --bt

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

допустимые значения: number, percentage

значение по умолчанию: number

--cancellation-threshold --cth

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

--cancellation-threshold-batch --ctb

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

--cancellation-threshold-type --ctt

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

допустимые значения: number, percentage

значение по умолчанию: number

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

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

значение по умолчанию: azureiotcentral.com

--content -k

Определение данных задания. Укажите путь к JSON-файлу или необработанным строкам JSON. Текст запроса должен содержать массив JobData.

--desc --description

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

--group-id -g

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

--job-name

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

--schedule

Расписание выполнения задания. Укажите путь к JSON-файлу или необработанным строкам JSON.

--token

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

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

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

значение по умолчанию: json

--query

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

--subscription

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

--verbose

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