BatchClient class
Client class for accessing пакетная служба Azure service.
Конструкторы
| Batch |
Методы
| create |
Пакетный сервис поддерживает два способа управления работой, выполняемой в рамках работы. В первом подходе пользователь задаёт задачу менеджера заданий. Пакетный сервис запускает эту задачу, когда готов начать работу. Задача менеджера заданий управляет всеми другими задачами, выполняемыми под этой задачей, используя API задач. Во втором подходе пользователь напрямую управляет выполнением задач под активной задачей, используя API задач. Также обратите внимание: при именовании вакансий избегайте включения конфиденциальной информации, такой как имена пользователей или секретные названия проектов. Эта информация может отображаться в телеметрических журналах, доступных инженерам служба поддержки Майкрософт. |
| create |
Создаёт расписание заданий для указанного аккаунта. |
| create |
Вы можете добавить пользовательскую учётную запись в вычислительный узел только в режиме простоя или в режиме запуска. Прежде чем удалённо войти в Compute Node, нужно настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration. |
| create |
При именовании пулов не следует включать конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эта информация может отображаться в телеметрических журналах, доступных инженерам служба поддержки Майкрософт. |
| create |
Максимальный срок службы задачи от добавления до завершения составляет 180 дней. Если задача не завершилась в течение 180 дней после добавления, она будет прекращена пакетным сервисом и оставлена в том состоянии, в котором находилась на тот момент. |
| create |
Обратите внимание, что каждая задача должна иметь уникальный идентификатор. Пакетная служба не может возвращать результаты для каждой задачи в том же порядке, в котором они были отправлены в этом запросе. Если сервер заканчивается или соединение закрывается во время запроса, запрос может быть частично или полностью обработан, а может и не быть вовсе. В таких случаях пользователь должен повторно отправить запрос. Обратите внимание, что именно пользователь должен правильно обрабатывать сбои при повторной отправке запроса. Например, при повторной попытке следует использовать одни и те же идентификаторы задач, чтобы если предыдущая операция прошла успешно, повторная попытка не создавала неожиданно дополнительные задачи. Если в ответе есть задачи, которые не были добавлены, клиент может повторить запрос. При повторной попытке наиболее эффективно повторно подавать только задачи, которые не были добавлены, и исключать задачи, которые были успешно добавлены с первой попытки. Максимальный срок службы задачи от добавления до завершения составляет 180 дней. Если задача не завершилась в течение 180 дней после добавления, она будет прекращена пакетным сервисом и оставлена в том состоянии, в котором находилась на тот момент. |
| deallocate |
Вы можете освободить вычислительный узел, только если он находится в состоянии простоя или выполнения. |
| delete |
Удаление работы также удаляет все задачи, входящие в эту работу, и всю статистику работы. Это также переопределяет период хранения данных Задач; то есть, если в задании есть задачи, которые всё ещё сохраняются на вычислительных узлах, пакетные сервисы удаляют рабочие каталоги этих задач и всё их содержимое. Когда поступает запрос на Delete Job, пакетная служба устанавливает Job в состояние удаления. Все операции обновления в работе, находящейся в состоянии удаления, будут провалены с кодом статуса 409 (Конфликт), с дополнительной информацией, указывающей на удаление задания. |
| delete |
При удалении расписания заданий это также удаляет все задания и задачи в этом расписании. При удалении задач все файлы в рабочих каталогах на вычислительных узлах также удаляются (срок хранения игнорируется). Статистика расписания заданий больше не доступна после удаления расписания заданий, хотя они по-прежнему учитываются в статистике времени существования учетной записи. |
| delete |
Удаляет указанный файл из вычислительного узла. |
| delete |
Учетную запись пользователя можно удалить на вычислительный узел только в том случае, если он находится в состоянии простоя или выполнения. Прежде чем удалённо войти в Compute Node, нужно настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration. |
| delete |
При запросе удаления пула выполняются следующие действия: состояние пула устанавливается для удаления; остановка любой текущей операции изменения размера в пуле; Пакетная служба начинает изменять размер пула до нуля вычислительных узлов; все задачи, выполняемые на существующих вычислительных узлах, завершаются и повторно запрашиваются (как если бы операция изменения размера пула была запрошена с параметром повторного запроса по умолчанию); Наконец, пул удаляется из системы. Так как выполнение задач повторно перезапущено, пользователь может повторно запустить эти задачи, обновив задание для назначения другого пула. Затем задачи могут выполняться в новом пуле. Если вы хотите переопределить поведение повторного запроса, необходимо явно вызвать изменение размера пула, чтобы уменьшить размер пула до нуля перед удалением пула. При вызове API обновления, исправления или удаления в пуле в состоянии удаления произойдет сбой с кодом состояния HTTP 409 с кодом ошибки PoolBeingDeleted. |
| delete |
При удалении задачи все файлы в каталоге на вычислительном узле, где он запущен, также удаляются (независимо от времени хранения). Для задач с несколькими экземплярами операция удаления задачи применяется синхронно к основной задаче; подзадачи и их файлы затем удаляются асинхронно в фоновом режиме. |
| delete |
Удаляет указанный файл задачи из вычислительного узла, где выполняется задача. |
| disable |
Группа немедленно переводит работу в состояние инвалидности. Batch затем использует параметр disableTasks, чтобы определить, что делать с текущими выполняющимися задачами задачи. Задание остаётся в состоянии отключения до завершения операции отключения и до тех пор, пока все задачи не будут обработаны в соответствии с опцией disableTasks; затем Джоб переходит в состояние инвалидности. Новые задачи не запускаются под работой, пока она не вернётся в активное состояние. Если вы попытаетесь отключить работу, находящуюся в любом состоянии, кроме активного, отключённого или отключённого, запрос с кодом статуса 409 не срабатывает. |
| disable |
Новые задания не будут созданы до включения расписания заданий. |
| disable |
Вы можете отключить планирование задач на вычислительном узле только если его текущее состояние планирования включено. |
| disable |
Отключает автоматическое масштабирование пула. |
| enable |
Когда вы вызываете этот API, пакетная служба устанавливает отключённую задачу в состояние включения. После завершения этой операции Задание переходит в активное состояние, и планирование новых Задач под Работой возобновляется. Сервис Batch не позволяет задаче оставаться в активном состоянии более 180 дней. Поэтому, если вы включите задание с активными задачами, добавленными более 180 дней назад, эти задачи не будут выполняться. |
| enable |
Включает расписание заданий. |
| enable |
Вы можете включить планирование задач на вычислительном узле только если его текущее состояние планирования отключено |
| enable |
Невозможно включить автоматическое масштабирование в пуле, если операция изменения размера выполняется в пуле. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Этот API нельзя вызывать для одного пула более одного раза каждые 30 секунд. |
| evaluate |
Этот API в основном предназначен для проверки формулы автомасштабирования, так как он просто возвращает результат, не применяя формулу к пулу. Пул должен иметь автоматическое масштабирование, чтобы оценить формулу. |
| get |
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; то есть это может быть использовано в ссылке на пакет. Для получения информации администратора о приложениях и версиях, которые пока недоступны для вычислительных узлов, используйте портал Azure или API Azure Resource Manager. |
| get |
Получает информацию о конкретной работе. |
| get |
Получает информацию о указанном расписании работы. |
| get |
Счетчики задач предоставляют количество задач по активному, выполнению или завершенной задаче, а также количеству задач, которые успешно или завершилось сбоем. Задачи в состоянии подготовки считаются запущенными. Обратите внимание, что возвращаемые числа могут не всегда быть актуальными. Если вам нужны точные счетчики задач, используйте запрос списка. |
| get |
Возвращает сведения о указанном вычислительном узле. |
| get |
Получает информацию о указанном расширении Compute Node. |
| get |
Возвращает содержимое указанного файла Compute Node. |
| get |
Возвращает свойства указанного файла вычислительного узла. |
| get |
Прежде чем удалённо войти в вычислительный узел с помощью удалённых настроек входа, необходимо создать учетную запись пользователя на вычислительном узле и настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration. |
| get |
Возвращает сведения о указанном пуле. |
| get |
Для многоэкземплярных задач такие данные, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API list subtasks для получения информации о подзадачах. |
| get |
Возвращает содержимое указанного файла задачи. |
| get |
Возвращает свойства указанного файла задачи. |
| job |
Проверяет наличие указанного расписания заданий. |
| list |
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; то есть это может быть использовано в ссылке на пакет. Для получения информации администратора о приложениях и версиях, которые пока недоступны для вычислительных узлов, используйте портал Azure или API Azure Resource Manager. |
| list |
Этот API возвращает состояние задачи подготовки задания и выпуска задания на всех вычислительных узлах, которые выполняют задачу подготовки задания или выпуска задания. К ним относятся вычислительные узлы, которые с тех пор были удалены из пула. Если этот API вызывается в задании, в котором нет задачи подготовки заданий или выпуска задания, пакетная служба возвращает код состояния HTTP 409 (конфликт) с кодом ошибки JobPreparationTaskNotSpecified. |
| list |
Перечисляет все вакансии в указанном аккаунте. |
| list |
Перечисляет все расписания заданий в указанном аккаунте. |
| list |
Перечисляет Вакансии, созданные в рамках указанного Расписания заданий. |
| list |
Перечисляет расширения вычислительных узлов в указанном пуле. |
| list |
Выводит список всех файлов в каталогах задач на указанном вычислительном узле. |
| list |
Выводит список вычислительных узлов в указанном пуле. |
| list |
Возвращает количество вычислительных узлов в каждом состоянии, сгруппированных по пулу. Обратите внимание, что возвращаемые числа могут не всегда быть актуальными. Если вам нужны точные счетчики узлов, используйте запрос списка. |
| list |
Выводит список всех пулов в указанной учетной записи. |
| list |
Если не указать предложение $filter, включая poolId, ответ включает все пулы, существующие в учетной записи, в диапазоне времени возвращаемых интервалов агрегирования. Если не указать предложение $filter, включая startTime или endTime, эти фильтры по умолчанию соответствуют времени начала и окончания последнего интервала агрегирования, доступного в данный момент; То есть возвращается только последний интервал агрегирования. |
| list |
Если задача не является задачей с несколькими экземплярами, возвращается пустая коллекция. |
| list |
Выводит список всех образов виртуальных машин, поддерживаемых службой пакетная служба Azure. |
| list |
Выводит список файлов в каталоге задачи на вычислительном узле. |
| list |
Для многоэкземплярных задач такие данные, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API list subtasks для получения информации о подзадачах. |
| pool |
Получает базовые свойства пула. |
| reactivate |
Повторная активация делает задачу доступной для повторной повторной отправки до максимального количества повторных попыток. Состояние задачи изменяется на активное. Так как задача больше не находится в состоянии завершения, все предыдущие сведения о выходе или сбое больше не доступны после повторной активации. Каждый раз при повторной активации задачи его количество повторных попыток сбрасывается до 0. Повторная активация завершится сбоем для задач, которые не завершены или которые ранее успешно завершены (с кодом выхода 0). Кроме того, он завершится ошибкой, если задание завершено (или завершается или удаляется). |
| reboot |
Вы можете перезапустить вычислительный узел, только если он находится в состоянии простоя или выполнения. |
| reimage |
Вы можете переустановить операционную систему на вычислительном узле, только если она находится в состоянии простоя или выполнения. Этот API можно вызвать только на пулах, созданных с помощью свойства конфигурации облачного сервиса. |
| remove |
Эта операция может выполняться только в том случае, если состояние выделения пула устойчиво. При выполнении этой операции состояние выделения изменяется от устойчивого к изменению размера. Каждый запрос может удалить до 100 узлов. |
| replace |
Это полностью заменяет все обновляемые свойства Работы. Например, если к заданию связаны ограничения, и если ограничения не указаны в этом запросе, то пакетная служба уберёт существующие ограничения. |
| replace |
Это полностью заменяет все обновляемые свойства расписания заданий. Например, если свойство расписания не указано в этом запросе, то пакетная служба удалит существующее расписание. Изменения в расписании заданий затрагивают только те задачи, созданные расписанием после обновления; В настоящее время работающие задачи не затронуты. |
| replace |
Эта операция заменяет все обновляемые свойства аккаунта. Например, если элемент expiryTime не указан, текущее значение заменяется на значение по умолчанию, а не оставляется неизмененным. Вы можете обновить пользовательскую учетную запись на вычислительном узле только в режиме простоя или работающего. |
| replace |
Это полностью заменяет все обновляемые свойства Пула. Например, если к пулу связана StartTask и если StartTask не указан в этом запросе, то пакетная служба удалит существующий StartTask. |
| replace |
Обновляет свойства указанной задачи. |
| resize |
Изменить размер пула можно только в том случае, если состояние выделения устойчиво. Если пул уже изменяется, запрос завершается ошибкой с кодом состояния 409. При изменении размера пула состояние выделения пула изменяется от устойчивого к изменению размера. Невозможно изменить размер пулов, настроенных для автоматического масштабирования. При попытке сделать это служба пакетной службы возвращает ошибку 409. Если изменить размер пула вниз, служба пакетной службы выбирает, какие вычислительные узлы следует удалить. Чтобы удалить определенные вычислительные узлы, используйте вместо этого API вычислительных узлов пула. |
| start |
Вы можете запустить Вычислительный узел только если он уже был распределён. |
| stop |
Это не восстанавливает Пул в его прежнее состояние до операции изменения размера: это лишь прекращает любые дальнейшие изменения, и Пул сохраняет текущее состояние. После остановки пул стабилизируется на уровне вычислительных узлов, на которых он находился при завершении операции остановки. Во время операции остановки состояние распределения пула сначала меняется на остановку, а затем на стабильную. Операция изменения размера не обязательно должна быть явным запросом на изменение размера пула; этот API также может использоваться для остановки начального размера пула при его создании. |
| terminate |
Когда поступает запрос на завершение работы, пакетная служба переводит задачу в состояние завершения. Пакетный сервис затем завершает все выполненные задачи, связанные с заданием, и выполняет все необходимые задачи выпуска заданий. Затем работа переходит в состояние завершения. Если в работе есть какие-либо задачи в активном состоянии, они останутся в активном состоянии. После завершения работы новые задачи нельзя добавлять, и оставшиеся активные задачи не будут запланированы. |
| terminate |
Завершает расписание заданий. |
| terminate |
После завершения задачи он перемещается в состояние завершения. Для задач с несколькими экземплярами операция завершения задачи применяется синхронно к основной задаче; Затем подзадачи завершаются асинхронно в фоновом режиме. |
| update |
Это заменяет только свойства Job, указанные в запросе. Например, если у Job есть ограничения, и запрос не указывает элемент constraints, то Job сохраняет существующие ограничения. |
| update |
Это заменяет только свойства расписания заданий, указанные в запросе. Например, если свойство расписания не указано в этом запросе, то пакетная служба сохраняет существующее расписание. Изменения в расписании заданий затрагивают только те задачи, созданные расписанием после обновления; В настоящее время работающие задачи не затронуты. |
| update |
Это заменяет только свойства пула, указанные в запросе. Например, если к пулу связан StartTask, а запрос не указывает элемент StartTask, то пул сохраняет существующий StartTask. |
| upload |
Это предназначено для автоматического сбора файлов журналов пакетная служба Azure из Compute Nodes, если вы столкнулись с ошибкой и хотите обратиться в поддержку Azure. Файлы журнала пакетная служба Azure службы должны предоставляться поддержка Azure, чтобы помочь в отладке проблем с пакетной службой. |
Сведения о конструкторе
BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)
new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)Параметры
- endpointParam
-
string
- credential
- options
- BatchClientOptionalParams
Сведения о методе
createJob(BatchJobCreateOptions, CreateJobOptionalParams)
Пакетный сервис поддерживает два способа управления работой, выполняемой в рамках работы. В первом подходе пользователь задаёт задачу менеджера заданий. Пакетный сервис запускает эту задачу, когда готов начать работу. Задача менеджера заданий управляет всеми другими задачами, выполняемыми под этой задачей, используя API задач. Во втором подходе пользователь напрямую управляет выполнением задач под активной задачей, используя API задач. Также обратите внимание: при именовании вакансий избегайте включения конфиденциальной информации, такой как имена пользователей или секретные названия проектов. Эта информация может отображаться в телеметрических журналах, доступных инженерам служба поддержки Майкрософт.
function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>Параметры
- options
- CreateJobOptionalParams
Возвращаемое значение
Promise<void>
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)
Создаёт расписание заданий для указанного аккаунта.
function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>Параметры
- jobSchedule
- BatchJobScheduleCreateOptions
- options
- CreateJobScheduleOptionalParams
Возвращаемое значение
Promise<void>
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)
Вы можете добавить пользовательскую учётную запись в вычислительный узел только в режиме простоя или в режиме запуска. Прежде чем удалённо войти в Compute Node, нужно настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration.
function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>Параметры
- poolId
-
string
- nodeId
-
string
- options
- CreateNodeUserOptionalParams
Возвращаемое значение
Promise<void>
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)
При именовании пулов не следует включать конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эта информация может отображаться в телеметрических журналах, доступных инженерам служба поддержки Майкрософт.
function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>Параметры
- options
- CreatePoolOptionalParams
Возвращаемое значение
Promise<void>
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)
Максимальный срок службы задачи от добавления до завершения составляет 180 дней. Если задача не завершилась в течение 180 дней после добавления, она будет прекращена пакетным сервисом и оставлена в том состоянии, в котором находилась на тот момент.
function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>Параметры
- jobId
-
string
- options
- CreateTaskOptionalParams
Возвращаемое значение
Promise<void>
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)
Обратите внимание, что каждая задача должна иметь уникальный идентификатор. Пакетная служба не может возвращать результаты для каждой задачи в том же порядке, в котором они были отправлены в этом запросе. Если сервер заканчивается или соединение закрывается во время запроса, запрос может быть частично или полностью обработан, а может и не быть вовсе. В таких случаях пользователь должен повторно отправить запрос. Обратите внимание, что именно пользователь должен правильно обрабатывать сбои при повторной отправке запроса. Например, при повторной попытке следует использовать одни и те же идентификаторы задач, чтобы если предыдущая операция прошла успешно, повторная попытка не создавала неожиданно дополнительные задачи. Если в ответе есть задачи, которые не были добавлены, клиент может повторить запрос. При повторной попытке наиболее эффективно повторно подавать только задачи, которые не были добавлены, и исключать задачи, которые были успешно добавлены с первой попытки. Максимальный срок службы задачи от добавления до завершения составляет 180 дней. Если задача не завершилась в течение 180 дней после добавления, она будет прекращена пакетным сервисом и оставлена в том состоянии, в котором находилась на тот момент.
function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>Параметры
- jobId
-
string
- taskCollection
- BatchTaskGroup
Возвращаемое значение
Promise<BatchCreateTaskCollectionResult>
deallocateNode(string, string, DeallocateNodeOptionalParams)
Вы можете освободить вычислительный узел, только если он находится в состоянии простоя или выполнения.
function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- nodeId
-
string
- options
- DeallocateNodeOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
deleteJob(string, DeleteJobOptionalParams)
Удаление работы также удаляет все задачи, входящие в эту работу, и всю статистику работы. Это также переопределяет период хранения данных Задач; то есть, если в задании есть задачи, которые всё ещё сохраняются на вычислительных узлах, пакетные сервисы удаляют рабочие каталоги этих задач и всё их содержимое. Когда поступает запрос на Delete Job, пакетная служба устанавливает Job в состояние удаления. Все операции обновления в работе, находящейся в состоянии удаления, будут провалены с кодом статуса 409 (Конфликт), с дополнительной информацией, указывающей на удаление задания.
function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>Параметры
- jobId
-
string
- options
- DeleteJobOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)
При удалении расписания заданий это также удаляет все задания и задачи в этом расписании. При удалении задач все файлы в рабочих каталогах на вычислительных узлах также удаляются (срок хранения игнорируется). Статистика расписания заданий больше не доступна после удаления расписания заданий, хотя они по-прежнему учитываются в статистике времени существования учетной записи.
function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>Параметры
- jobScheduleId
-
string
- options
- DeleteJobScheduleOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)
Удаляет указанный файл из вычислительного узла.
function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>Параметры
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- DeleteNodeFileOptionalParams
Возвращаемое значение
Promise<void>
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)
Учетную запись пользователя можно удалить на вычислительный узел только в том случае, если он находится в состоянии простоя или выполнения. Прежде чем удалённо войти в Compute Node, нужно настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration.
function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>Параметры
- poolId
-
string
- nodeId
-
string
- userName
-
string
- options
- DeleteNodeUserOptionalParams
Возвращаемое значение
Promise<void>
deletePool(string, DeletePoolOptionalParams)
При запросе удаления пула выполняются следующие действия: состояние пула устанавливается для удаления; остановка любой текущей операции изменения размера в пуле; Пакетная служба начинает изменять размер пула до нуля вычислительных узлов; все задачи, выполняемые на существующих вычислительных узлах, завершаются и повторно запрашиваются (как если бы операция изменения размера пула была запрошена с параметром повторного запроса по умолчанию); Наконец, пул удаляется из системы. Так как выполнение задач повторно перезапущено, пользователь может повторно запустить эти задачи, обновив задание для назначения другого пула. Затем задачи могут выполняться в новом пуле. Если вы хотите переопределить поведение повторного запроса, необходимо явно вызвать изменение размера пула, чтобы уменьшить размер пула до нуля перед удалением пула. При вызове API обновления, исправления или удаления в пуле в состоянии удаления произойдет сбой с кодом состояния HTTP 409 с кодом ошибки PoolBeingDeleted.
function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- options
- DeletePoolOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
deleteTask(string, string, DeleteTaskOptionalParams)
При удалении задачи все файлы в каталоге на вычислительном узле, где он запущен, также удаляются (независимо от времени хранения). Для задач с несколькими экземплярами операция удаления задачи применяется синхронно к основной задаче; подзадачи и их файлы затем удаляются асинхронно в фоновом режиме.
function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>Параметры
- jobId
-
string
- taskId
-
string
- options
- DeleteTaskOptionalParams
Возвращаемое значение
Promise<void>
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)
Удаляет указанный файл задачи из вычислительного узла, где выполняется задача.
function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>Параметры
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- DeleteTaskFileOptionalParams
Возвращаемое значение
Promise<void>
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)
Группа немедленно переводит работу в состояние инвалидности. Batch затем использует параметр disableTasks, чтобы определить, что делать с текущими выполняющимися задачами задачи. Задание остаётся в состоянии отключения до завершения операции отключения и до тех пор, пока все задачи не будут обработаны в соответствии с опцией disableTasks; затем Джоб переходит в состояние инвалидности. Новые задачи не запускаются под работой, пока она не вернётся в активное состояние. Если вы попытаетесь отключить работу, находящуюся в любом состоянии, кроме активного, отключённого или отключённого, запрос с кодом статуса 409 не срабатывает.
function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>Параметры
- jobId
-
string
- disableOptions
- BatchJobDisableOptions
- options
- DisableJobOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
disableJobSchedule(string, DisableJobScheduleOptionalParams)
Новые задания не будут созданы до включения расписания заданий.
function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>Параметры
- jobScheduleId
-
string
- options
- DisableJobScheduleOptionalParams
Возвращаемое значение
Promise<void>
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)
Вы можете отключить планирование задач на вычислительном узле только если его текущее состояние планирования включено.
function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>Параметры
- poolId
-
string
- nodeId
-
string
Возвращаемое значение
Promise<void>
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)
Отключает автоматическое масштабирование пула.
function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>Параметры
- poolId
-
string
Возвращаемое значение
Promise<void>
enableJob(string, EnableJobOptionalParams)
Когда вы вызываете этот API, пакетная служба устанавливает отключённую задачу в состояние включения. После завершения этой операции Задание переходит в активное состояние, и планирование новых Задач под Работой возобновляется. Сервис Batch не позволяет задаче оставаться в активном состоянии более 180 дней. Поэтому, если вы включите задание с активными задачами, добавленными более 180 дней назад, эти задачи не будут выполняться.
function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>Параметры
- jobId
-
string
- options
- EnableJobOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
enableJobSchedule(string, EnableJobScheduleOptionalParams)
Включает расписание заданий.
function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>Параметры
- jobScheduleId
-
string
- options
- EnableJobScheduleOptionalParams
Возвращаемое значение
Promise<void>
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)
Вы можете включить планирование задач на вычислительном узле только если его текущее состояние планирования отключено
function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>Параметры
- poolId
-
string
- nodeId
-
string
Возвращаемое значение
Promise<void>
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)
Невозможно включить автоматическое масштабирование в пуле, если операция изменения размера выполняется в пуле. Если автоматическое масштабирование пула в настоящее время отключено, необходимо указать допустимую формулу автомасштабирования в рамках запроса. Если автоматическое масштабирование пула уже включено, можно указать новую формулу автомасштабирования и (или) новый интервал оценки. Этот API нельзя вызывать для одного пула более одного раза каждые 30 секунд.
function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>Параметры
- poolId
-
string
- enableAutoScaleOptions
- BatchPoolEnableAutoScaleOptions
Возвращаемое значение
Promise<void>
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)
Этот API в основном предназначен для проверки формулы автомасштабирования, так как он просто возвращает результат, не применяя формулу к пулу. Пул должен иметь автоматическое масштабирование, чтобы оценить формулу.
function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>Параметры
- poolId
-
string
- evaluateAutoScaleOptions
- BatchPoolEvaluateAutoScaleOptions
Возвращаемое значение
Promise<AutoScaleRun>
getApplication(string, GetApplicationOptionalParams)
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; то есть это может быть использовано в ссылке на пакет. Для получения информации администратора о приложениях и версиях, которые пока недоступны для вычислительных узлов, используйте портал Azure или API Azure Resource Manager.
function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>Параметры
- applicationId
-
string
- options
- GetApplicationOptionalParams
Возвращаемое значение
Promise<BatchApplication>
getJob(string, GetJobOptionalParams)
Получает информацию о конкретной работе.
function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>Параметры
- jobId
-
string
- options
- GetJobOptionalParams
Возвращаемое значение
Promise<BatchJob>
getJobSchedule(string, GetJobScheduleOptionalParams)
Получает информацию о указанном расписании работы.
function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>Параметры
- jobScheduleId
-
string
- options
- GetJobScheduleOptionalParams
Возвращаемое значение
Promise<BatchJobSchedule>
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)
Счетчики задач предоставляют количество задач по активному, выполнению или завершенной задаче, а также количеству задач, которые успешно или завершилось сбоем. Задачи в состоянии подготовки считаются запущенными. Обратите внимание, что возвращаемые числа могут не всегда быть актуальными. Если вам нужны точные счетчики задач, используйте запрос списка.
function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>Параметры
- jobId
-
string
- options
- GetJobTaskCountsOptionalParams
Возвращаемое значение
Promise<BatchTaskCountsResult>
getNode(string, string, GetNodeOptionalParams)
Возвращает сведения о указанном вычислительном узле.
function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>Параметры
- poolId
-
string
- nodeId
-
string
- options
- GetNodeOptionalParams
Возвращаемое значение
Promise<BatchNode>
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)
Получает информацию о указанном расширении Compute Node.
function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>Параметры
- poolId
-
string
- nodeId
-
string
- extensionName
-
string
- options
- GetNodeExtensionOptionalParams
Возвращаемое значение
Promise<BatchNodeVMExtension>
getNodeFile(string, string, string, GetNodeFileOptionalParams)
Возвращает содержимое указанного файла Compute Node.
function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>Параметры
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- GetNodeFileOptionalParams
Возвращаемое значение
Promise<Uint8Array>
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)
Возвращает свойства указанного файла вычислительного узла.
function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>Параметры
- poolId
-
string
- nodeId
-
string
- filePath
-
string
Возвращаемое значение
Promise<BatchNodeFile>
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)
Прежде чем удалённо войти в вычислительный узел с помощью удалённых настроек входа, необходимо создать учетную запись пользователя на вычислительном узле и настроить порты доступа для SSH и RDP. Дополнительные сведения см. по ссылке https://learn.microsoft.com/azure/batch/pool-endpoint-configuration.
function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>Параметры
- poolId
-
string
- nodeId
-
string
Возвращаемое значение
Promise<BatchNodeRemoteLoginSettings>
getPool(string, GetPoolOptionalParams)
Возвращает сведения о указанном пуле.
function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>Параметры
- poolId
-
string
- options
- GetPoolOptionalParams
Возвращаемое значение
Promise<BatchPool>
getTask(string, string, GetTaskOptionalParams)
Для многоэкземплярных задач такие данные, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API list subtasks для получения информации о подзадачах.
function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>Параметры
- jobId
-
string
- taskId
-
string
- options
- GetTaskOptionalParams
Возвращаемое значение
Promise<BatchTask>
getTaskFile(string, string, string, GetTaskFileOptionalParams)
Возвращает содержимое указанного файла задачи.
function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>Параметры
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- GetTaskFileOptionalParams
Возвращаемое значение
Promise<Uint8Array>
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)
Возвращает свойства указанного файла задачи.
function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>Параметры
- jobId
-
string
- taskId
-
string
- filePath
-
string
Возвращаемое значение
Promise<BatchNodeFile>
jobScheduleExists(string, JobScheduleExistsOptionalParams)
Проверяет наличие указанного расписания заданий.
function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>Параметры
- jobScheduleId
-
string
- options
- JobScheduleExistsOptionalParams
Возвращаемое значение
Promise<boolean>
listApplications(ListApplicationsOptionalParams)
Эта операция возвращает только приложения и версии, доступные для использования на вычислительных узлах; то есть это может быть использовано в ссылке на пакет. Для получения информации администратора о приложениях и версиях, которые пока недоступны для вычислительных узлов, используйте портал Azure или API Azure Resource Manager.
function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>Параметры
- options
- ListApplicationsOptionalParams
Возвращаемое значение
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)
Этот API возвращает состояние задачи подготовки задания и выпуска задания на всех вычислительных узлах, которые выполняют задачу подготовки задания или выпуска задания. К ним относятся вычислительные узлы, которые с тех пор были удалены из пула. Если этот API вызывается в задании, в котором нет задачи подготовки заданий или выпуска задания, пакетная служба возвращает код состояния HTTP 409 (конфликт) с кодом ошибки JobPreparationTaskNotSpecified.
function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>Параметры
- jobId
-
string
Возвращаемое значение
listJobs(ListJobsOptionalParams)
Перечисляет все вакансии в указанном аккаунте.
function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>Параметры
- options
- ListJobsOptionalParams
Возвращаемое значение
listJobSchedules(ListJobSchedulesOptionalParams)
Перечисляет все расписания заданий в указанном аккаунте.
function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>Параметры
- options
- ListJobSchedulesOptionalParams
Возвращаемое значение
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)
Перечисляет Вакансии, созданные в рамках указанного Расписания заданий.
function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>Параметры
- jobScheduleId
-
string
Возвращаемое значение
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)
Перечисляет расширения вычислительных узлов в указанном пуле.
function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>Параметры
- poolId
-
string
- nodeId
-
string
- options
- ListNodeExtensionsOptionalParams
Возвращаемое значение
listNodeFiles(string, string, ListNodeFilesOptionalParams)
Выводит список всех файлов в каталогах задач на указанном вычислительном узле.
function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>Параметры
- poolId
-
string
- nodeId
-
string
- options
- ListNodeFilesOptionalParams
Возвращаемое значение
listNodes(string, ListNodesOptionalParams)
Выводит список вычислительных узлов в указанном пуле.
function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>Параметры
- poolId
-
string
- options
- ListNodesOptionalParams
Возвращаемое значение
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)
Возвращает количество вычислительных узлов в каждом состоянии, сгруппированных по пулу. Обратите внимание, что возвращаемые числа могут не всегда быть актуальными. Если вам нужны точные счетчики узлов, используйте запрос списка.
function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>Параметры
- options
- ListPoolNodeCountsOptionalParams
Возвращаемое значение
listPools(ListPoolsOptionalParams)
Выводит список всех пулов в указанной учетной записи.
function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>Параметры
- options
- ListPoolsOptionalParams
Возвращаемое значение
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)
Если не указать предложение $filter, включая poolId, ответ включает все пулы, существующие в учетной записи, в диапазоне времени возвращаемых интервалов агрегирования. Если не указать предложение $filter, включая startTime или endTime, эти фильтры по умолчанию соответствуют времени начала и окончания последнего интервала агрегирования, доступного в данный момент; То есть возвращается только последний интервал агрегирования.
function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>Параметры
Возвращаемое значение
listSubTasks(string, string, ListSubTasksOptionalParams)
Если задача не является задачей с несколькими экземплярами, возвращается пустая коллекция.
function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>Параметры
- jobId
-
string
- taskId
-
string
- options
- ListSubTasksOptionalParams
Возвращаемое значение
listSupportedImages(ListSupportedImagesOptionalParams)
Выводит список всех образов виртуальных машин, поддерживаемых службой пакетная служба Azure.
function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>Параметры
Возвращаемое значение
listTaskFiles(string, string, ListTaskFilesOptionalParams)
Выводит список файлов в каталоге задачи на вычислительном узле.
function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>Параметры
- jobId
-
string
- taskId
-
string
- options
- ListTaskFilesOptionalParams
Возвращаемое значение
listTasks(string, ListTasksOptionalParams)
Для многоэкземплярных задач такие данные, как affinityId, executionInfo и nodeInfo, относятся к основной задаче. Используйте API list subtasks для получения информации о подзадачах.
function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>Параметры
- jobId
-
string
- options
- ListTasksOptionalParams
Возвращаемое значение
poolExists(string, PoolExistsOptionalParams)
Получает базовые свойства пула.
function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>Параметры
- poolId
-
string
- options
- PoolExistsOptionalParams
Возвращаемое значение
Promise<boolean>
reactivateTask(string, string, ReactivateTaskOptionalParams)
Повторная активация делает задачу доступной для повторной повторной отправки до максимального количества повторных попыток. Состояние задачи изменяется на активное. Так как задача больше не находится в состоянии завершения, все предыдущие сведения о выходе или сбое больше не доступны после повторной активации. Каждый раз при повторной активации задачи его количество повторных попыток сбрасывается до 0. Повторная активация завершится сбоем для задач, которые не завершены или которые ранее успешно завершены (с кодом выхода 0). Кроме того, он завершится ошибкой, если задание завершено (или завершается или удаляется).
function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>Параметры
- jobId
-
string
- taskId
-
string
- options
- ReactivateTaskOptionalParams
Возвращаемое значение
Promise<void>
rebootNode(string, string, RebootNodeOptionalParams)
Вы можете перезапустить вычислительный узел, только если он находится в состоянии простоя или выполнения.
function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- nodeId
-
string
- options
- RebootNodeOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
reimageNode(string, string, ReimageNodeOptionalParams)
Вы можете переустановить операционную систему на вычислительном узле, только если она находится в состоянии простоя или выполнения. Этот API можно вызвать только на пулах, созданных с помощью свойства конфигурации облачного сервиса.
function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- nodeId
-
string
- options
- ReimageNodeOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)
Эта операция может выполняться только в том случае, если состояние выделения пула устойчиво. При выполнении этой операции состояние выделения изменяется от устойчивого к изменению размера. Каждый запрос может удалить до 100 узлов.
function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- removeOptions
- BatchNodeRemoveOptions
- options
- RemoveNodesOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
replaceJob(string, BatchJob, ReplaceJobOptionalParams)
Это полностью заменяет все обновляемые свойства Работы. Например, если к заданию связаны ограничения, и если ограничения не указаны в этом запросе, то пакетная служба уберёт существующие ограничения.
function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>Параметры
- jobId
-
string
- job
- BatchJob
- options
- ReplaceJobOptionalParams
Возвращаемое значение
Promise<void>
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)
Это полностью заменяет все обновляемые свойства расписания заданий. Например, если свойство расписания не указано в этом запросе, то пакетная служба удалит существующее расписание. Изменения в расписании заданий затрагивают только те задачи, созданные расписанием после обновления; В настоящее время работающие задачи не затронуты.
function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>Параметры
- jobScheduleId
-
string
- jobSchedule
- BatchJobSchedule
- options
- ReplaceJobScheduleOptionalParams
Возвращаемое значение
Promise<void>
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)
Эта операция заменяет все обновляемые свойства аккаунта. Например, если элемент expiryTime не указан, текущее значение заменяется на значение по умолчанию, а не оставляется неизмененным. Вы можете обновить пользовательскую учетную запись на вычислительном узле только в режиме простоя или работающего.
function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>Параметры
- poolId
-
string
- nodeId
-
string
- userName
-
string
- updateOptions
- BatchNodeUserUpdateOptions
- options
- ReplaceNodeUserOptionalParams
Возвращаемое значение
Promise<void>
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)
Это полностью заменяет все обновляемые свойства Пула. Например, если к пулу связана StartTask и если StartTask не указан в этом запросе, то пакетная служба удалит существующий StartTask.
function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>Параметры
- poolId
-
string
Возвращаемое значение
Promise<void>
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)
Обновляет свойства указанной задачи.
function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>Параметры
- jobId
-
string
- taskId
-
string
- task
- BatchTask
- options
- ReplaceTaskOptionalParams
Возвращаемое значение
Promise<void>
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)
Изменить размер пула можно только в том случае, если состояние выделения устойчиво. Если пул уже изменяется, запрос завершается ошибкой с кодом состояния 409. При изменении размера пула состояние выделения пула изменяется от устойчивого к изменению размера. Невозможно изменить размер пулов, настроенных для автоматического масштабирования. При попытке сделать это служба пакетной службы возвращает ошибку 409. Если изменить размер пула вниз, служба пакетной службы выбирает, какие вычислительные узлы следует удалить. Чтобы удалить определенные вычислительные узлы, используйте вместо этого API вычислительных узлов пула.
function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- resizeOptions
- BatchPoolResizeOptions
- options
- ResizePoolOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
startNode(string, string, StartNodeOptionalParams)
Вы можете запустить Вычислительный узел только если он уже был распределён.
function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- nodeId
-
string
- options
- StartNodeOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
stopPoolResize(string, StopPoolResizeOptionalParams)
Это не восстанавливает Пул в его прежнее состояние до операции изменения размера: это лишь прекращает любые дальнейшие изменения, и Пул сохраняет текущее состояние. После остановки пул стабилизируется на уровне вычислительных узлов, на которых он находился при завершении операции остановки. Во время операции остановки состояние распределения пула сначала меняется на остановку, а затем на стабильную. Операция изменения размера не обязательно должна быть явным запросом на изменение размера пула; этот API также может использоваться для остановки начального размера пула при его создании.
function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>Параметры
- poolId
-
string
- options
- StopPoolResizeOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
terminateJob(string, TerminateJobOptionalParams)
Когда поступает запрос на завершение работы, пакетная служба переводит задачу в состояние завершения. Пакетный сервис затем завершает все выполненные задачи, связанные с заданием, и выполняет все необходимые задачи выпуска заданий. Затем работа переходит в состояние завершения. Если в работе есть какие-либо задачи в активном состоянии, они останутся в активном состоянии. После завершения работы новые задачи нельзя добавлять, и оставшиеся активные задачи не будут запланированы.
function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>Параметры
- jobId
-
string
- options
- TerminateJobOptionalParams
Возвращаемое значение
PollerLike<OperationState<void>, void>
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)
Завершает расписание заданий.
function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>Параметры
- jobScheduleId
-
string
Возвращаемое значение
PollerLike<OperationState<void>, void>
terminateTask(string, string, TerminateTaskOptionalParams)
После завершения задачи он перемещается в состояние завершения. Для задач с несколькими экземплярами операция завершения задачи применяется синхронно к основной задаче; Затем подзадачи завершаются асинхронно в фоновом режиме.
function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>Параметры
- jobId
-
string
- taskId
-
string
- options
- TerminateTaskOptionalParams
Возвращаемое значение
Promise<void>
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)
Это заменяет только свойства Job, указанные в запросе. Например, если у Job есть ограничения, и запрос не указывает элемент constraints, то Job сохраняет существующие ограничения.
function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>Параметры
- jobId
-
string
- options
- UpdateJobOptionalParams
Возвращаемое значение
Promise<void>
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)
Это заменяет только свойства расписания заданий, указанные в запросе. Например, если свойство расписания не указано в этом запросе, то пакетная служба сохраняет существующее расписание. Изменения в расписании заданий затрагивают только те задачи, созданные расписанием после обновления; В настоящее время работающие задачи не затронуты.
function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>Параметры
- jobScheduleId
-
string
- jobSchedule
- BatchJobScheduleUpdateOptions
- options
- UpdateJobScheduleOptionalParams
Возвращаемое значение
Promise<void>
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)
Это заменяет только свойства пула, указанные в запросе. Например, если к пулу связан StartTask, а запрос не указывает элемент StartTask, то пул сохраняет существующий StartTask.
function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>Параметры
- poolId
-
string
- options
- UpdatePoolOptionalParams
Возвращаемое значение
Promise<void>
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)
Это предназначено для автоматического сбора файлов журналов пакетная служба Azure из Compute Nodes, если вы столкнулись с ошибкой и хотите обратиться в поддержку Azure. Файлы журнала пакетная служба Azure службы должны предоставляться поддержка Azure, чтобы помочь в отладке проблем с пакетной службой.
function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>Параметры
- poolId
-
string
- nodeId
-
string
- uploadOptions
- UploadBatchServiceLogsOptions
- options
- UploadNodeLogsOptionalParams
Возвращаемое значение
Promise<UploadBatchServiceLogsResult>