az batch job
Управление заданиями пакетной службы.
Команды
| Имя | Описание | Тип | Состояние |
|---|---|---|---|
| az batch job create |
Добавьте задание в учетную запись пакетной службы. |
Core | GA |
| az batch job delete |
Удаляет задание из учетной записи пакетной службы. |
Core | GA |
| az batch job disable |
Отключение задания пакетной службы. |
Core | GA |
| az batch job enable |
Включите пакетное задание. |
Core | GA |
| az batch job list |
Список всех заданий или расписания заданий в учетной записи пакетной службы. |
Core | GA |
| az batch job prep-release-status |
Просмотр состояния задач подготовки и выпуска пакетного задания. |
Core | GA |
| az batch job prep-release-status list |
Выводит состояние выполнения задачи подготовки задания и выпуска задания для указанного задания на вычислительных узлах, где выполняется задание. |
Core | GA |
| az batch job reset |
Обновите свойства задания пакетной службы. Неопределенные свойства, которые можно обновить, сбрасываются по умолчанию. |
Core | GA |
| az batch job set |
Обновите свойства задания пакетной службы. Обновление свойства в подгруппе приведет к сбросу неопределенных свойств этой группы. |
Core | GA |
| az batch job show |
Возвращает сведения об указанном задании пакетной службы. |
Core | GA |
| az batch job stop |
Остановите выполняемое пакетное задание. |
Core | GA |
| az batch job task-counts |
Просмотрите количество задач и слотов в задании пакетной службы и их состояниях. |
Core | GA |
| az batch job task-counts show |
Возвращает количество задач для указанного задания. |
Core | GA |
az batch job create
Добавьте задание в учетную запись пакетной службы.
az batch job create [--account-endpoint]
[--account-key]
[--account-name]
[--allow-task-preemption]
[--id]
[--job-manager-task-application-package-references]
[--job-manager-task-command-line]
[--job-manager-task-environment-settings]
[--job-manager-task-id]
[--job-manager-task-resource-files]
[--job-max-task-retry-count]
[--job-max-wall-clock-time]
[--json-file]
[--max-parallel-tasks]
[--metadata]
[--on-all-tasks-complete]
[--pool-id]
[--priority]
[--required-slots]
[--uses-task-dependencies]
Примеры
Создайте новое задание, связанное с существующим пулом.
az batch job create --id job1 --pool-id pool1
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Можно ли выполнять задачи в этом задании с высоким приоритетом. Если для значения задано значение True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут перезапускать задачи из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption. Значение True, если флаг присутствует.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Строка, которая однозначно идентифицирует задание в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор является сохранением регистра и не учитывает регистр (т. е. у вас не может быть двух идентификаторов в учетной записи, которые отличаются только по регистру). Required.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Список пакетов приложений, которые служба пакетной службы будет развертывать на вычислительном узле перед выполнением командной строки. Пакеты приложений загружаются и развертываются в общий каталог, а не в рабочий каталог задач. Таким образом, если указанный пакет приложения уже находится на вычислительном узле и находится в актуальном состоянии, он не скачан повторно; Используется существующую копию на вычислительном узле. Если не удается установить указанный пакет приложения, например из-за того, что пакет был удален или сбой загрузки, задача завершается ошибкой. Идентификаторы приложений с разделительным пространством с необязательной версией в формате id[#version].
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Job Manager Task Arguments |
Командная строка задачи диспетчера заданий. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). Required.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Job Manager Task Arguments |
Список параметров переменной среды для задачи Диспетчера заданий. Разделенные пробелами значения в формате key=value.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Job Manager Task Arguments |
Строка, которая однозначно идентифицирует задачу диспетчера заданий в задании. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и подчеркивания, и не может содержать более 64 символов. Required.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Job Manager Task Arguments |
Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. Ссылки на ресурсы, разделенные пробелами, в формате filename=httpurl.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Job Manager Task Arguments |
Максимальное количество повторных попыток каждой задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить каждую задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачи. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачи без ограничения. Значение по умолчанию равно 0 (без повторных попыток).
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Constraints Arguments |
Максимальное время выполнения задания, измеряемое с момента создания задания. Если задание не завершается в течение периода времени, пакетная служба завершает ее и все задачи, которые по-прежнему выполняются. В этом случае причиной завершения будет MaxWallClockTimeExpiry. Если это свойство не указано, время выполнения задания не ограничено. Ожидаемый формат — это длительность ISO-8601.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Constraints Arguments |
Файл, содержащий спецификацию задания в ФОРМАТЕ JSON (отформатированный для соответствия соответствующему тексту REST API). Если этот параметр указан, все аргументы задания игнорируются.
Максимальное количество задач, которые могут выполняться параллельно для задания. Значение maxParallelTasks должно быть -1 или больше 0, если указано. Если значение по умолчанию не указано, значение по умолчанию равно -1, что означает, что количество задач, которые могут выполняться одновременно, не ограничено. После создания задания с помощью API задания обновления можно обновить maxParallelTasks.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Список пар "имя-значение", связанных с заданием в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода. Разделенные пробелами значения в формате key=value.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения. Обратите внимание, что если задание не содержит задач, все задачи считаются завершенными. Поэтому этот параметр чаще всего используется с задачей диспетчера заданий; Если вы хотите использовать автоматическое завершение задания без диспетчера заданий, сначала необходимо задать значение noaction onAllTasksComplete и обновить свойства задания, чтобы задать значение onAllTasksComplete, чтобы завершить работу после завершения добавления задач. Значение по умолчанию — noaction. Известные значения: "noaction" и "terminatejob".
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Идентификатор существующего пула. Все задачи задания будут выполняться в указанном пуле. Необходимо убедиться, что пул, на который ссылается это свойство. Если пул не существует в то время, когда пакетная служба пытается запланировать задание, задачи для задания не будут выполняться, пока не создадите пул с этим идентификатором. Обратите внимание, что пакетная служба не отклонит запрос задания; Он просто не будет запускать задачи до тех пор, пока пул не существует. Необходимо указать идентификатор пула или спецификацию авто пула, но не оба.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Pool Info Arguments |
Приоритет задания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Количество слотов планирования, которые требуется выполнить задаче. Значение по умолчанию — 1. Задача может выполняться только на вычислительном узле, если узел имеет достаточно свободных слотов планирования. Для задач с несколькими экземплярами это свойство не поддерживается и не должно быть указано.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Job Manager Task Arguments |
Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false. Значение True, если флаг присутствует.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job delete
Удаляет задание из учетной записи пакетной службы.
az batch job delete --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--yes]
Примеры
Удалите задание с помощью идентификатора задания без запроса на подтверждение.
az batch job delete --job-id job1 --yes
Обязательные параметры
Идентификатор удаленного задания. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Не запрашивать подтверждение.
| Свойство | Значение |
|---|---|
| Default value: | False |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job disable
Отключение задания пакетной службы.
az batch job disable --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--disable-tasks]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--json-file]
Примеры
Отключите задание и повторно выполните все выполняемые задачи.
az batch job disable --job-id job1 --disable-tasks requeue
Обязательные параметры
Идентификатор задания, отключаемого. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Что делать с активными задачами, связанными с заданием. Required. Известные значения: "requeue", "terminate" и "wait".
| Свойство | Значение |
|---|---|
| Parameter group: | Content Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Файл, содержащий спецификацию содержимого в ФОРМАТЕ JSON (отформатированный в соответствии с соответствующим текстом REST API). Если этот параметр указан, все аргументы содержимого игнорируются.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job enable
Включите пакетное задание.
az batch job enable --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
Примеры
Включите задание.
az batch job enable --job-id job1
Обязательные параметры
Идентификатор включенного задания. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job list
Список всех заданий или расписания заданий в учетной записи пакетной службы.
az batch job list [--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--filter]
[--job-schedule-id]
[--select]
Примеры
Список всех заданий в учетной записи пакетной службы
az batch job list
Список всех расписаний заданий в учетной записи пакетной службы
az batch job list --job-schedule-id jobschedule1
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, необходимо задать только переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Предложение OData $expand.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Идентификатор расписания задания, из которого вы хотите получить список заданий. Если опущено, список всех заданий в учетной записи.
Предложение OData $select.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job reset
Обновите свойства задания пакетной службы. Неопределенные свойства, которые можно обновить, сбрасываются по умолчанию.
az batch job reset --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--allow-task-preemption]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--job-max-task-retry-count]
[--job-max-wall-clock-time]
[--json-file]
[--max-parallel-tasks]
[--metadata]
[--on-all-tasks-complete]
[--pool-id]
[--priority]
Примеры
Сбросьте все свойства задания, кроме приоритета.
az batch job reset --job-id job1 --priority 100
Обязательные параметры
Идентификатор задания, свойства которого необходимо обновить. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Можно ли выполнять задачи в этом задании с высоким приоритетом. Если для значения задано значение True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут перезапускать задачи из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption. Значение True, если флаг присутствует.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Максимальное количество повторных попыток каждой задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить каждую задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачи. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачи без ограничения. Значение по умолчанию равно 0 (без повторных попыток).
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Constraints Arguments |
Максимальное время выполнения задания, измеряемое с момента создания задания. Если задание не завершается в течение периода времени, пакетная служба завершает ее и все задачи, которые по-прежнему выполняются. В этом случае причиной завершения будет MaxWallClockTimeExpiry. Если это свойство не указано, время выполнения задания не ограничено. Ожидаемый формат — это длительность ISO-8601.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Constraints Arguments |
Файл, содержащий спецификацию задания в ФОРМАТЕ JSON (отформатированный для соответствия соответствующему тексту REST API). Если этот параметр указан, все аргументы задания игнорируются.
Максимальное количество задач, которые могут выполняться параллельно для задания. Значение maxParallelTasks должно быть -1 или больше 0, если указано. Если значение по умолчанию не указано, значение по умолчанию равно -1, что означает, что количество задач, которые могут выполняться одновременно, не ограничено. После создания задания с помощью API задания обновления можно обновить maxParallelTasks.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Список пар "имя-значение", связанных с заданием в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода. Разделенные пробелами значения в формате key=value.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения. Значение по умолчанию — noaction. Известные значения: "noaction" и "terminatejob".
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Идентификатор существующего пула. Все задачи задания будут выполняться в указанном пуле. Необходимо убедиться, что пул, на который ссылается это свойство. Если пул не существует в то время, когда пакетная служба пытается запланировать задание, задачи для задания не будут выполняться, пока не создадите пул с этим идентификатором. Обратите внимание, что пакетная служба не отклонит запрос задания; Он просто не будет запускать задачи до тех пор, пока пул не существует. Необходимо указать идентификатор пула или спецификацию авто пула, но не оба.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Pool Info Arguments |
Приоритет задания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job set
Обновите свойства задания пакетной службы. Обновление свойства в подгруппе приведет к сбросу неопределенных свойств этой группы.
az batch job set --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--allow-task-preemption]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--job-max-task-retry-count]
[--job-max-wall-clock-time]
[--json-file]
[--max-parallel-tasks]
[--metadata]
[--on-all-tasks-complete]
[--pool-id]
[--priority]
Примеры
Обновление приоритета задания.
az batch job set --job-id job1 --priority 100
Обязательные параметры
Идентификатор задания, свойства которого необходимо обновить. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Можно ли выполнять задачи в этом задании с высоким приоритетом. Если для значения задано значение True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут перезапускать задачи из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption. Значение True, если флаг присутствует.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Максимальное количество повторных попыток каждой задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить каждую задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачи. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачи без ограничения. Значение по умолчанию равно 0 (без повторных попыток).
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Constraints Arguments |
Максимальное время выполнения задания, измеряемое с момента создания задания. Если задание не завершается в течение периода времени, пакетная служба завершает ее и все задачи, которые по-прежнему выполняются. В этом случае причиной завершения будет MaxWallClockTimeExpiry. Если это свойство не указано, время выполнения задания не ограничено. Ожидаемый формат — это длительность ISO-8601.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Constraints Arguments |
Файл, содержащий спецификацию задания в ФОРМАТЕ JSON (отформатированный для соответствия соответствующему тексту REST API). Если этот параметр указан, все аргументы задания игнорируются.
Максимальное количество задач, которые могут выполняться параллельно для задания. Значение maxParallelTasks должно быть -1 или больше 0, если указано. Если значение по умолчанию не указано, значение по умолчанию равно -1, что означает, что количество задач, которые могут выполняться одновременно, не ограничено. После создания задания с помощью API задания обновления можно обновить maxParallelTasks.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Список пар "имя-значение", связанных с заданием в качестве метаданных. Если не указано, существующие метаданные задания остаются неизменными. Разделенные пробелами значения в формате key=value.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения. Если опущено, поведение завершения остается неизменным. Вы не можете изменить значение с завершения задания на noaction , т. е. после автоматического завершения задания вы не можете отключить его снова. При попытке сделать это запрос завершается ошибкой с сообщением об ошибке "недопустимое значение свойства"; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Известные значения: "noaction" и "terminatejob".
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Идентификатор существующего пула. Все задачи задания будут выполняться в указанном пуле. Необходимо убедиться, что пул, на который ссылается это свойство. Если пул не существует в то время, когда пакетная служба пытается запланировать задание, задачи для задания не будут выполняться, пока не создадите пул с этим идентификатором. Обратите внимание, что пакетная служба не отклонит запрос задания; Он просто не будет запускать задачи до тех пор, пока пул не существует. Необходимо указать идентификатор пула или спецификацию авто пула, но не оба.
| Свойство | Значение |
|---|---|
| Parameter group: | Job: Pool Info Arguments |
Приоритет задания. Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Если опущено, приоритет задания остается неизменным.
| Свойство | Значение |
|---|---|
| Parameter group: | Job Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job show
Возвращает сведения об указанном задании пакетной службы.
az batch job show --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--expand]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--select]
Примеры
Отображает сведения о задании.
az batch job show --job-id job1
Обязательные параметры
Идентификатор задания. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Предложение OData $expand.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Предложение OData $select.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |
az batch job stop
Остановите выполняемое пакетное задание.
Завершите указанное задание, пометив его как завершенное. При получении запроса на завершение задания служба пакетной службы устанавливает задание в состояние завершения. Затем пакетная служба завершает все выполняемые задачи, связанные с заданием, и выполняет все необходимые задачи выпуска задания. Затем задание перемещается в завершенное состояние. Если в задании есть какие-либо задачи в активном состоянии, они останутся в активном состоянии. После завершения задания новые задачи не могут быть добавлены, а остальные активные задачи не будут запланированы.
az batch job stop --job-id
[--account-endpoint]
[--account-key]
[--account-name]
[--if-match]
[--if-modified-since]
[--if-none-match]
[--if-unmodified-since]
[--terminate-reason]
Примеры
Остановка задания и предоставление причины завершения
az batch job stop --job-id job1 --terminate-reason "Completed workflow"
Обязательные параметры
Идентификатор завершения задания. Required.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Конечная точка пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ENDPOINT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Ключ учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCESS_KEY.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Имя учетной записи пакетной службы. Кроме того, задайте переменную среды: AZURE_BATCH_ACCOUNT.
| Свойство | Значение |
|---|---|
| Parameter group: | Batch Account Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе точно соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Значение ETag, связанное с версией ресурса, известного клиенту. Операция будет выполнена только в том случае, если текущий ETag ресурса в службе не соответствует значению, указанному клиентом.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
| Свойство | Значение |
|---|---|
| Parameter group: | Pre-condition and Query Arguments |
Причина завершения.
Текст, который вы хотите отображать в качестве задания TerminateReason. Значение по умолчанию — UserTerminate.
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
| Свойство | Значение |
|---|---|
| Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
| Свойство | Значение |
|---|---|
| Default value: | False |
Формат вывода.
| Свойство | Значение |
|---|---|
| Default value: | json |
| Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
| Свойство | Значение |
|---|---|
| Default value: | False |