BatchPool interface

Пакет:

@azure/batch

A pool in the пакетная служба Azure service.

Свойства

allocationState	Изменяется ли размер пула.
allocationStateTransitionTime	Время, в течение которого пул ввел текущее состояние выделения.
applicationPackageReferences	Список пакетов, установленных на каждом вычислительном узле в пуле. Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.
autoScaleEvaluationInterval	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Это свойство задается только в том случае, если пул автоматически масштабируется, т. е. enableAutoScale имеет значение true. Длительность времени указана в формате ISO 8601.
autoScaleFormula	Формула для требуемого количества вычислительных узлов в пуле. Это свойство задается только в том случае, если пул автоматически масштабируется, т. е. enableAutoScale имеет значение true.
autoScaleRun	Результаты и ошибки из последнего выполнения формулы автомасштабирования. Это свойство задается только в том случае, если пул автоматически масштабируется, т. е. enableAutoScale имеет значение true.
creationTime	Время создания пула.
currentDedicatedNodes	Количество выделенных вычислительных узлов в настоящее время в пуле.
currentLowPriorityNodes	Количество точечных или низкоприоритетных вычислительных узлов в пуле. Точечные и низкоприоритетные вычислительные узлы, которые были предварительно подготовлены, включены в это число.
displayName	Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale	Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. По умолчанию используется значение false.
enableInterNodeCommunication	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. По умолчанию используется значение false.
eTag	ETag пула. Это непрозрачная строка. Его можно использовать для определения того, изменился ли пул между запросами. В частности, вы можете передать ETag при обновлении пула, чтобы указать, что изменения должны вступили в силу только в том случае, если никто другой не изменил пул в то же время.
id	Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор является сохранением регистра и не учитывает регистр (т. е. у вас не может быть двух идентификаторов в учетной записи, которые отличаются только по регистру).
identity	Удостоверение пула пакетной службы, если настроено. Список удостоверений пользователей, связанных с пулом пакетной службы. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
lastModified	Время последнего изменения пула. Это последний раз, когда данные уровня пула, такие как целевыеDedicatedNodes или enableAutoscale settings, изменились. Он не учитывает изменения на уровне узла, такие как состояние изменения вычислительного узла.
metadata	Список пар "имя-значение", связанных с пулом в качестве метаданных.
mountConfiguration	Монтирование хранилища с использованием указанной файловой системы на весь срок жизни пула. Монтировать хранилище с помощью файловой системы Azure, NFS, CIFS или файловой системы на базе Blobfuse.
networkConfiguration	Конфигурация сети для пула.
poolStatistics	Статистика использования ресурсов и использования ресурсов в течение всего времени существования пула. Это свойство заполняется только в том случае, если пакетная служба BatchPool была получена с предложением expand, включая атрибут stats; в противном случае значение null. Статистика может быть недоступна сразу. Пакетная служба выполняет периодический свертки статистики. Типичная задержка составляет около 30 минут.
resizeErrors	Список ошибок, возникших при выполнении последнего изменения размера в пуле. Это свойство задается только в том случае, если во время последнего изменения размера пула произошла одна или несколько ошибок, и только в том случае, если значение распределения пула устойчиво.
resizeTimeout	Время ожидания выделения вычислительных узлов в пул. Это время ожидания для последней операции изменения размера. (Начальный размер при создании пула считается изменением размера.) Значение по умолчанию — 15 минут. Длительность времени указана в формате ISO 8601.
startTask	Задача, указанная для запуска на каждом вычислительном узле при присоединении к пулу.
state	Текущее состояние пула.
stateTransitionTime	Время ввода пула в текущее состояние.
targetDedicatedNodes	Требуемое количество выделенных вычислительных узлов в пуле.
targetLowPriorityNodes	Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле.
taskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию распространяется.
taskSlotsPerNode	Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.
upgradePolicy	Политика обновления для пула. Описывает политику обновления — автоматическую, ручную или перекатную.
url	URL-адрес пула.
userAccounts	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration	Конфигурация виртуальной машины для пула. Задание этого свойства обязательно.
vmSize	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Для информации о доступных размерах виртуальных машин в пулах см. раздел «Выбрать размер виртуальной машины для вычислительных узлов в пуле пакетная служба Azure (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

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

allocationState

Изменяется ли размер пула.

allocationState?: AllocationState

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

AllocationState

allocationStateTransitionTime

Время, в течение которого пул ввел текущее состояние выделения.

allocationStateTransitionTime?: Date

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

Date

applicationPackageReferences

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

applicationPackageReferences?: BatchApplicationPackageReference[]

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

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Это свойство задается только в том случае, если пул автоматически масштабируется, т. е. enableAutoScale имеет значение true. Длительность времени указана в формате ISO 8601.

autoScaleEvaluationInterval?: string

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

string

autoScaleFormula

Формула для требуемого количества вычислительных узлов в пуле. Это свойство задается только в том случае, если пул автоматически масштабируется, т. е. enableAutoScale имеет значение true.

autoScaleFormula?: string

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

string

autoScaleRun

Результаты и ошибки из последнего выполнения формулы автомасштабирования. Это свойство задается только в том случае, если пул автоматически масштабируется, т. е. enableAutoScale имеет значение true.

autoScaleRun?: AutoScaleRun

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

AutoScaleRun

creationTime

Время создания пула.

creationTime: Date

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

Date

currentDedicatedNodes

Количество выделенных вычислительных узлов в настоящее время в пуле.

currentDedicatedNodes: number

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

number

currentLowPriorityNodes

Количество точечных или низкоприоритетных вычислительных узлов в пуле. Точечные и низкоприоритетные вычислительные узлы, которые были предварительно подготовлены, включены в это число.

currentLowPriorityNodes: number

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

number

displayName

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

displayName?: string

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

string

enableAutoScale

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

enableAutoScale?: boolean

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

boolean

enableInterNodeCommunication

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

enableInterNodeCommunication?: boolean

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

boolean

eTag

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

eTag: string

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

string

id

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

id: string

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

string

identity

Удостоверение пула пакетной службы, если настроено. Список удостоверений пользователей, связанных с пулом пакетной службы. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

identity?: BatchPoolIdentity

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

BatchPoolIdentity

lastModified

Время последнего изменения пула. Это последний раз, когда данные уровня пула, такие как целевыеDedicatedNodes или enableAutoscale settings, изменились. Он не учитывает изменения на уровне узла, такие как состояние изменения вычислительного узла.

lastModified: Date

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

Date

metadata

Список пар "имя-значение", связанных с пулом в качестве метаданных.

metadata?: BatchMetadataItem[]

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

BatchMetadataItem[]

mountConfiguration

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

mountConfiguration?: MountConfiguration[]

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

MountConfiguration[]

networkConfiguration

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

networkConfiguration?: NetworkConfiguration

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

NetworkConfiguration

poolStatistics

Статистика использования ресурсов и использования ресурсов в течение всего времени существования пула. Это свойство заполняется только в том случае, если пакетная служба BatchPool была получена с предложением expand, включая атрибут stats; в противном случае значение null. Статистика может быть недоступна сразу. Пакетная служба выполняет периодический свертки статистики. Типичная задержка составляет около 30 минут.

poolStatistics?: BatchPoolStatistics

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

BatchPoolStatistics

resizeErrors

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

resizeErrors?: ResizeError[]

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

ResizeError[]

resizeTimeout

Время ожидания выделения вычислительных узлов в пул. Это время ожидания для последней операции изменения размера. (Начальный размер при создании пула считается изменением размера.) Значение по умолчанию — 15 минут. Длительность времени указана в формате ISO 8601.

resizeTimeout?: string

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

string

startTask

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

startTask?: BatchStartTask

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

BatchStartTask

state

Текущее состояние пула.

state: BatchPoolState

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

BatchPoolState

stateTransitionTime

Время ввода пула в текущее состояние.

stateTransitionTime: Date

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

Date

targetDedicatedNodes

Требуемое количество выделенных вычислительных узлов в пуле.

targetDedicatedNodes?: number

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

number

targetLowPriorityNodes

Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле.

targetLowPriorityNodes?: number

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

number

taskSchedulingPolicy

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

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

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

BatchTaskSchedulingPolicy

taskSlotsPerNode

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

taskSlotsPerNode?: number

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

number

upgradePolicy

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

upgradePolicy?: UpgradePolicy

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

UpgradePolicy

url

URL-адрес пула.

url: string

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

string

userAccounts

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

userAccounts?: UserAccount[]

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

UserAccount[]

virtualMachineConfiguration

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

virtualMachineConfiguration?: VirtualMachineConfiguration

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

VirtualMachineConfiguration

vmSize

Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Для информации о доступных размерах виртуальных машин в пулах см. раздел «Выбрать размер виртуальной машины для вычислительных узлов в пуле пакетная служба Azure (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

vmSize: string

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

string