BatchPoolCreateOptions interface

Пакет:

@azure/batch

Parameters for creating a пакетная служба Azure Pool.

Свойства

applicationPackageReferences	Список пакетов, установленных на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полностью квалифицирован (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.
autoScaleEvaluationInterval	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.
autoScaleFormula	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Требуется, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, служба пакетной службы отклоняет запрос с подробными сведениями об ошибке. Для получения дополнительной информации о задании этой формулы см. «Автоматическое масштабирование вычислительных узлов в пакетная служба Azure пуле» (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
displayName	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale	Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. По умолчанию используется значение false.
enableInterNodeCommunication	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. По умолчанию используется значение false.
id	Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас могут не быть двух идентификаторов пула в учетной записи, которые отличаются только по регистру).
metadata	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration	Монтирование хранилища с использованием указанной файловой системы на весь срок жизни пула. Монтировать хранилище с помощью файловой системы Azure, NFS, CIFS или файловой системы на базе Blobfuse.
networkConfiguration	Конфигурация сети для пула.
resizeTimeout	Время ожидания выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.
startTask	Задача, указанная для запуска на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.
targetLowPriorityNodes	Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.
taskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию распространяется.
taskSlotsPerNode	Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.
upgradePolicy	Политика обновления для пула. Описывает политику обновления — автоматическую, ручную или перекатную.
userAccounts	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration	Конфигурация виртуальной машины для пула. Задание этого свойства обязательно.
vmSize	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Для информации о доступных размерах виртуальных машин для пулов, использующих изображения с Виртуальные машины Marketplace (пулы, созданные с помощью virtualMachineConfiguration), см. раздел Размеры для Виртуальные машины в Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Пакетный режим поддерживает все Azure размеры виртуальных машин, кроме STANDARD_A0 и тех, что имеют премиальный накопитель (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).

Сведения о свойстве

applicationPackageReferences

Список пакетов, установленных на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полностью квалифицирован (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.

applicationPackageReferences?: BatchApplicationPackageReference[]

Значение свойства

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.

autoScaleEvaluationInterval?: string

Значение свойства

string

autoScaleFormula

Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Требуется, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, служба пакетной службы отклоняет запрос с подробными сведениями об ошибке. Для получения дополнительной информации о задании этой формулы см. «Автоматическое масштабирование вычислительных узлов в пакетная служба Azure пуле» (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

autoScaleFormula?: string

Значение свойства

string

displayName

Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.

displayName?: string

Значение свойства

string

enableAutoScale

Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. По умолчанию используется значение false.

enableAutoScale?: boolean

Значение свойства

boolean

enableInterNodeCommunication

Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. По умолчанию используется значение false.

enableInterNodeCommunication?: boolean

Значение свойства

boolean

id

Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас могут не быть двух идентификаторов пула в учетной записи, которые отличаются только по регистру).

id: string

Значение свойства

string

metadata

Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.

metadata?: BatchMetadataItem[]

Значение свойства

BatchMetadataItem[]

mountConfiguration

Монтирование хранилища с использованием указанной файловой системы на весь срок жизни пула. Монтировать хранилище с помощью файловой системы Azure, NFS, CIFS или файловой системы на базе Blobfuse.

mountConfiguration?: MountConfiguration[]

Значение свойства

MountConfiguration[]

networkConfiguration

Конфигурация сети для пула.

networkConfiguration?: NetworkConfiguration

Значение свойства

NetworkConfiguration

resizeTimeout

Время ожидания выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.

resizeTimeout?: string

Значение свойства

string

startTask

Задача, указанная для запуска на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.

startTask?: BatchStartTask

Значение свойства

BatchStartTask

targetDedicatedNodes

Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.

targetDedicatedNodes?: number

Значение свойства

number

targetLowPriorityNodes

Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.

targetLowPriorityNodes?: number

Значение свойства

number

taskSchedulingPolicy

Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию распространяется.

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

Значение свойства

BatchTaskSchedulingPolicy

taskSlotsPerNode

Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.

taskSlotsPerNode?: number

Значение свойства

number

upgradePolicy

Политика обновления для пула. Описывает политику обновления — автоматическую, ручную или перекатную.

upgradePolicy?: UpgradePolicy

Значение свойства

UpgradePolicy

userAccounts

Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.

userAccounts?: UserAccount[]

Значение свойства

UserAccount[]

virtualMachineConfiguration

Конфигурация виртуальной машины для пула. Задание этого свойства обязательно.

virtualMachineConfiguration?: VirtualMachineConfiguration

Значение свойства

VirtualMachineConfiguration

vmSize

Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Для информации о доступных размерах виртуальных машин для пулов, использующих изображения с Виртуальные машины Marketplace (пулы, созданные с помощью virtualMachineConfiguration), см. раздел Размеры для Виртуальные машины в Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Пакетный режим поддерживает все Azure размеры виртуальных машин, кроме STANDARD_A0 и тех, что имеют премиальный накопитель (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).

vmSize: string

Значение свойства

string