BatchPoolCreateOptions interface

Paquete:

@azure/batch

Parámetros para crear un Azure Batch Pool.

Propiedades

applicationPackageReferences	Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. Al crear un pool, el ID de aplicación del paquete debe estar completamente cualificado (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft). Batch/batchAccounts/{accountName}/applications/{applicationName}). Los cambios en las referencias de paquete afectan a todos los nodos nuevos que se unen al grupo, pero no afectan a los nodos de proceso que ya están en el grupo hasta que se reinician o se vuelven a crear imágenes. Hay un máximo de 10 referencias de paquete en cualquier grupo determinado.
autoScaleEvaluationInterval	Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). La duración del tiempo se especifica en el formato ISO 8601.
autoScaleFormula	Fórmula para el número deseado de nodos de proceso en el grupo. Esta propiedad no se debe especificar si enableAutoScale está establecido en false. Es necesario si enableAutoScale está establecido en true. La fórmula se comprueba si hay validez antes de crear el grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. Para más información sobre cómo especificar esta fórmula, véase 'Escalar automáticamente nodos de cómputo en un Azure Batch pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
displayName	Nombre para mostrar del grupo. El nombre para mostrar no debe ser único y puede contener caracteres Unicode de hasta una longitud máxima de 1024.
enableAutoScale	Si el tamaño del grupo se debe ajustar automáticamente con el tiempo. Si es false, se debe especificar al menos uno de targetDedicatedNodes y targetLowPriorityNodes. Si es true, se requiere la propiedad autoScaleFormula y el grupo cambia automáticamente el tamaño según la fórmula. El valor predeterminado es false.
enableInterNodeCommunication	Si el grupo permite la comunicación directa entre nodos de proceso. Habilitar la comunicación entre nodos limita el tamaño máximo del grupo debido a restricciones de implementación en los nodos de proceso del grupo. Esto puede dar lugar a que el grupo no alcance su tamaño deseado. El valor predeterminado es false.
id	Cadena que identifica de forma única el grupo dentro de la cuenta. El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. El identificador se conserva entre mayúsculas y minúsculas y no distingue mayúsculas de minúsculas (es decir, es posible que no tenga dos identificadores de grupo dentro de una cuenta que solo sea diferente por caso).
metadata	Lista de pares nombre-valor asociados al grupo como metadatos. El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.
mountConfiguration	Monte el almacenamiento utilizando el sistema de archivos especificado durante toda la vida útil del grupo. Monta el almacenamiento usando Azure fileshare, NFS, CIFS o un sistema de archivos basado en Blobfuse.
networkConfiguration	Configuración de red para el grupo.
resizeTimeout	Tiempo de espera para la asignación de nodos de proceso al grupo. Este tiempo de espera solo se aplica al escalado manual; no tiene ningún efecto cuando enableAutoScale se establece en true. El valor predeterminado es 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). La duración del tiempo se especifica en el formato ISO 8601.
startTask	Tarea especificada para ejecutarse en cada nodo de proceso a medida que se une al grupo. La tarea se ejecuta cuando se agrega el nodo de proceso al grupo o cuando se reinicia el nodo de proceso.
targetDedicatedNodes	Número deseado de nodos de proceso dedicados en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.
targetLowPriorityNodes	Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.
taskSchedulingPolicy	Cómo se distribuyen las tareas entre nodos de proceso de un grupo. Si no se especifica, el valor predeterminado se propaga.
taskSlotsPerNode	El número de ranuras de tareas que pueden usarse para ejecutar tareas simultáneas en un solo nodo de ejecución en el grupo. El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos de vmSize del grupo o 256.
upgradePolicy	Directiva de actualización para el grupo. Describe una directiva de actualización: automática, manual o gradual.
userAccounts	Lista de cuentas de usuario que se van a crear en cada nodo de proceso del grupo.
virtualMachineConfiguration	Configuración de la máquina virtual para el grupo. Es necesario especificar esta propiedad.
vmSize	Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño. Para información sobre los tamaños disponibles de VM para pools usando imágenes del Virtual Machines Marketplace (pools creados con virtualMachineConfiguration), véase Tamaños para Virtual Machines en Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch soporta todos los tamaños de VM de Azure excepto STANDARD_A0 y aquellas con almacenamiento premium (series STANDARD_GS, STANDARD_DS y STANDARD_DSV2).

Detalles de las propiedades

applicationPackageReferences

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. Al crear un pool, el ID de aplicación del paquete debe estar completamente cualificado (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft). Batch/batchAccounts/{accountName}/applications/{applicationName}). Los cambios en las referencias de paquete afectan a todos los nodos nuevos que se unen al grupo, pero no afectan a los nodos de proceso que ya están en el grupo hasta que se reinician o se vuelven a crear imágenes. Hay un máximo de 10 referencias de paquete en cualquier grupo determinado.

applicationPackageReferences?: BatchApplicationPackageReference[]

Valor de propiedad

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático. El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). La duración del tiempo se especifica en el formato ISO 8601.

autoScaleEvaluationInterval?: string

Valor de propiedad

string

autoScaleFormula

Fórmula para el número deseado de nodos de proceso en el grupo. Esta propiedad no se debe especificar si enableAutoScale está establecido en false. Es necesario si enableAutoScale está establecido en true. La fórmula se comprueba si hay validez antes de crear el grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. Para más información sobre cómo especificar esta fórmula, véase 'Escalar automáticamente nodos de cómputo en un Azure Batch pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

autoScaleFormula?: string

Valor de propiedad

string

displayName

Nombre para mostrar del grupo. El nombre para mostrar no debe ser único y puede contener caracteres Unicode de hasta una longitud máxima de 1024.

displayName?: string

Valor de propiedad

string

enableAutoScale

Si el tamaño del grupo se debe ajustar automáticamente con el tiempo. Si es false, se debe especificar al menos uno de targetDedicatedNodes y targetLowPriorityNodes. Si es true, se requiere la propiedad autoScaleFormula y el grupo cambia automáticamente el tamaño según la fórmula. El valor predeterminado es false.

enableAutoScale?: boolean

Valor de propiedad

boolean

enableInterNodeCommunication

Si el grupo permite la comunicación directa entre nodos de proceso. Habilitar la comunicación entre nodos limita el tamaño máximo del grupo debido a restricciones de implementación en los nodos de proceso del grupo. Esto puede dar lugar a que el grupo no alcance su tamaño deseado. El valor predeterminado es false.

enableInterNodeCommunication?: boolean

Valor de propiedad

boolean

id

Cadena que identifica de forma única el grupo dentro de la cuenta. El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. El identificador se conserva entre mayúsculas y minúsculas y no distingue mayúsculas de minúsculas (es decir, es posible que no tenga dos identificadores de grupo dentro de una cuenta que solo sea diferente por caso).

id: string

Valor de propiedad

string

metadata

Lista de pares nombre-valor asociados al grupo como metadatos. El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.

metadata?: BatchMetadataItem[]

Valor de propiedad

BatchMetadataItem[]

mountConfiguration

Monte el almacenamiento utilizando el sistema de archivos especificado durante toda la vida útil del grupo. Monta el almacenamiento usando Azure fileshare, NFS, CIFS o un sistema de archivos basado en Blobfuse.

mountConfiguration?: MountConfiguration[]

Valor de propiedad

MountConfiguration[]

networkConfiguration

Configuración de red para el grupo.

networkConfiguration?: NetworkConfiguration

Valor de propiedad

NetworkConfiguration

resizeTimeout

Tiempo de espera para la asignación de nodos de proceso al grupo. Este tiempo de espera solo se aplica al escalado manual; no tiene ningún efecto cuando enableAutoScale se establece en true. El valor predeterminado es 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). La duración del tiempo se especifica en el formato ISO 8601.

resizeTimeout?: string

Valor de propiedad

string

startTask

Tarea especificada para ejecutarse en cada nodo de proceso a medida que se une al grupo. La tarea se ejecuta cuando se agrega el nodo de proceso al grupo o cuando se reinicia el nodo de proceso.

startTask?: BatchStartTask

Valor de propiedad

BatchStartTask

targetDedicatedNodes

Número deseado de nodos de proceso dedicados en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

targetDedicatedNodes?: number

Valor de propiedad

number

targetLowPriorityNodes

Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo. Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

targetLowPriorityNodes?: number

Valor de propiedad

number

taskSchedulingPolicy

Cómo se distribuyen las tareas entre nodos de proceso de un grupo. Si no se especifica, el valor predeterminado se propaga.

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

Valor de propiedad

BatchTaskSchedulingPolicy

taskSlotsPerNode

El número de ranuras de tareas que pueden usarse para ejecutar tareas simultáneas en un solo nodo de ejecución en el grupo. El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos de vmSize del grupo o 256.

taskSlotsPerNode?: number

Valor de propiedad

number

upgradePolicy

Directiva de actualización para el grupo. Describe una directiva de actualización: automática, manual o gradual.

upgradePolicy?: UpgradePolicy

Valor de propiedad

UpgradePolicy

userAccounts

Lista de cuentas de usuario que se van a crear en cada nodo de proceso del grupo.

userAccounts?: UserAccount[]

Valor de propiedad

UserAccount[]

virtualMachineConfiguration

Configuración de la máquina virtual para el grupo. Es necesario especificar esta propiedad.

virtualMachineConfiguration?: VirtualMachineConfiguration

Valor de propiedad

VirtualMachineConfiguration

vmSize

Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño. Para información sobre los tamaños disponibles de VM para pools usando imágenes del Virtual Machines Marketplace (pools creados con virtualMachineConfiguration), véase Tamaños para Virtual Machines en Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch soporta todos los tamaños de VM de Azure excepto STANDARD_A0 y aquellas con almacenamiento premium (series STANDARD_GS, STANDARD_DS y STANDARD_DSV2).

vmSize: string

Valor de propiedad

string