Compartir a través de

PoolAddParameter interface

Paquete:
@azure/batch

Interfaz que representa PoolAddParameter.

Propiedades

applicationLicenses

La lista de licencias de aplicación que el servicio Batch pondrá a disposición en cada nodo de proceso del grupo. La lista de licencias de aplicación debe ser un subconjunto de licencias de aplicaciones de servicio de Batch disponibles. Si se solicita una licencia que no se admite, se producirá un error en la creación del grupo.
applicationPackageReferences

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. 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 de 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).
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, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences

Lista de certificados que se van a instalar en cada nodo de proceso del grupo. En el caso de los nodos de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio.
cloudServiceConfiguration

Configuración del servicio en la nube para el grupo. Esta propiedad y virtualMachineConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades. Esta propiedad no se puede especificar si la cuenta de Batch se creó con su propiedad poolAllocationMode establecida en "UserSubscription".
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 targetDedicateNodes 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 mediante el sistema de archivos especificado para toda la duración del grupo. Monte el almacenamiento mediante el recurso compartido de archivos de Azure, NFS, CIFS o el 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 de 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).
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 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

Número de ranuras de tareas que se pueden usar para ejecutar tareas simultáneas en un único nodo de proceso del 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.
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. Esta propiedad y cloudServiceConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades.
vmSize

Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño. Para obtener información sobre los tamaños disponibles de las máquinas virtuales para grupos de Cloud Services (grupos creados con cloudServiceConfiguration), consulte Tamaños de Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch admite todos los tamaños de máquina virtual de Cloud Services excepto ExtraSmall, A1V2 y A2V2. Para obtener información sobre los tamaños de máquina virtual disponibles para grupos que usan imágenes de Marketplace de máquinas virtuales (grupos creados con virtualMachineConfiguration), consulte Tamaños de máquinas virtuales (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) o Tamaños de máquinas virtuales (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch admite todos los tamaños de máquina virtual de Azure, excepto STANDARD_A0 y aquellos con premium Storage (STANDARD_GS, STANDARD_DS y serie STANDARD_DSV2).

Detalles de las propiedades

applicationLicenses

La lista de licencias de aplicación que el servicio Batch pondrá a disposición en cada nodo de proceso del grupo. La lista de licencias de aplicación debe ser un subconjunto de licencias de aplicaciones de servicio de Batch disponibles. Si se solicita una licencia que no se admite, se producirá un error en la creación del grupo.

applicationLicenses?: string[]

Valor de propiedad

string[]

applicationPackageReferences

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. 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?: ApplicationPackageReference[]

Valor de propiedad

ApplicationPackageReference[]

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 de 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).

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, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

autoScaleFormula?: string

Valor de propiedad

string

certificateReferences

Lista de certificados que se van a instalar en cada nodo de proceso del grupo. En el caso de los nodos de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio.

certificateReferences?: CertificateReference[]

Valor de propiedad

CertificateReference[]

cloudServiceConfiguration

Configuración del servicio en la nube para el grupo. Esta propiedad y virtualMachineConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades. Esta propiedad no se puede especificar si la cuenta de Batch se creó con su propiedad poolAllocationMode establecida en "UserSubscription".

cloudServiceConfiguration?: CloudServiceConfiguration

Valor de propiedad

CloudServiceConfiguration

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 targetDedicateNodes 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?: MetadataItem[]

Valor de propiedad

MetadataItem[]

mountConfiguration

Monte el almacenamiento mediante el sistema de archivos especificado para toda la duración del grupo. Monte el almacenamiento mediante el recurso compartido de archivos de Azure, NFS, CIFS o el 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 de 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).

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?: StartTask

Valor de propiedad

StartTask

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 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?: TaskSchedulingPolicy

Valor de propiedad

TaskSchedulingPolicy

taskSlotsPerNode

Número de ranuras de tareas que se pueden usar para ejecutar tareas simultáneas en un único nodo de proceso del 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

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. Esta propiedad y cloudServiceConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades.

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 obtener información sobre los tamaños disponibles de las máquinas virtuales para grupos de Cloud Services (grupos creados con cloudServiceConfiguration), consulte Tamaños de Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch admite todos los tamaños de máquina virtual de Cloud Services excepto ExtraSmall, A1V2 y A2V2. Para obtener información sobre los tamaños de máquina virtual disponibles para grupos que usan imágenes de Marketplace de máquinas virtuales (grupos creados con virtualMachineConfiguration), consulte Tamaños de máquinas virtuales (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) o Tamaños de máquinas virtuales (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch admite todos los tamaños de máquina virtual de Azure, excepto STANDARD_A0 y aquellos con premium Storage (STANDARD_GS, STANDARD_DS y serie STANDARD_DSV2).

vmSize: string

Valor de propiedad

string