BatchTaskCreateOptions interface

Paquete:

@azure/batch

Parámetros para crear una tarea Azure Batch.

Propiedades

affinityInfo	Una pista de localidad que puede ser utilizada por el servicio por lotes para seleccionar un Nodo de Cómputo desde el que iniciar la nueva Tarea.
applicationPackageReferences	Una lista de paquetes que el servicio Batch desplegará en el Nodo de Cómputo antes de ejecutar la línea de comandos. Los paquetes de aplicación se descargan y despliegan en un directorio compartido, no en el directorio de trabajo de Tareas. Por lo tanto, si un paquete referenciado ya está en el Nodo y está actualizado, no se vuelve a descargar; se utiliza la copia existente en el Nodo de Cómputo. Si no se puede instalar un paquete referenciado, por ejemplo porque se ha eliminado o porque la descarga falló, la tarea falla.
commandLine	La línea de comandos de la Tarea. Para las tareas multiinstancia, la línea de comandos se ejecuta como la tarea principal, después de que la tarea principal y todas las subtareas hayan terminado de ejecutar la línea de coordenación. La línea de comandos no se ejecuta en un shell y, por tanto, no puede aprovechar las características del shell, como la expansión de variables de entorno. Si quieres aprovechar estas funciones, deberías invocar el shell en la línea de comandos, por ejemplo usando "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	Las restricciones de ejecución que se aplican a esta tarea. Si no especificas restricciones, el maxTaskRetryCount es el maxTaskRetryCount especificado para el Job, el maxWallClockTime, es infinito y el retentionTime es de 7 días.
containerSettings	Los ajustes del contenedor bajo el cual se ejecuta la tarea. Si el Pool que ejecutará esta Tarea tiene configurado containerConfiguration, esto también debe configurarse. Si el Pool que ejecutará esta tarea no tiene containerConfiguration activado, esto no debe configurarse. Cuando esto se especifica, todos los directorios recursivamente por debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de Azure Batch directorios en el nodo) se mapean en el contenedor, todas las variables del entorno de Tarea se mapean en el contenedor y la línea de comandos de Tarea se ejecuta en el contenedor. Los archivos producidos en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR pueden no reflejarse en el disco anfitrión, lo que significa que las APIs de archivos por lotes no podrán acceder a esos archivos.
dependsOn	Las tareas de las que depende esta tarea. Esta tarea no se programará hasta que todas las tareas de las que depende se hayan completado con éxito. Si alguna de esas tareas falla y agota su número de intentos, esta tarea nunca se programará. Si el Trabajo no tiene usesTaskDependencies configuradas en true, y este elemento está presente, la solicitud falla con el código de error TaskDependenciesNotSpecifiedOnJob.
displayName	Un nombre de visualización para la Tarea. El nombre para mostrar no debe ser único y puede contener caracteres Unicode de hasta una longitud máxima de 1024.
environmentSettings	Una lista de ajustes de variables de entorno para la Tarea.
exitConditions	Cómo debe responder el servicio por lotes cuando la tarea se complete.
id	Una cadena que identifica de forma única la Tarea dentro del Trabajo. 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 ID preserva mayúsculas y no es insensible a minúsculas (es decir, puede que no tengas dos IDs dentro de un Job que solo difieran por caso).
multiInstanceSettings	Un objeto que indica que la tarea es una tarea multiinstancia y contiene información sobre cómo ejecutarla.
outputFiles	Una lista de archivos que el servicio Batch cargará desde el Nodo de Cómputo tras ejecutar la línea de comandos. Para tareas multiinstancia, los archivos solo se cargarán desde el nodo de cómputo en el que se ejecuta la tarea principal.
requiredSlots	El número de espacios de programación que la Tarea requería para ejecutarse. El valor predeterminado es 1. Una tarea solo puede programarse para ejecutarse en un nodo de cómputo si este tiene suficientes espacios libres de planificación disponibles. Para tareas multiinstancia, esto debe ser 1.
resourceFiles	Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. Para tareas multiinstancia, los archivos de recursos solo se descargan al nodo de cómputo en el que se ejecuta la tarea principal. Hay un tamaño máximo para la lista de archivos de recursos. Cuando se supera el tamaño máximo, se producirá un error en la solicitud y el código de error de respuesta será RequestEntityTooLarge. Si esto ocurre, la colección de ResourceFiles debe reducirse en tamaño. Esto se puede lograr mediante archivos de .zip, paquetes de aplicación o contenedores de Docker.
userIdentity	La identidad de usuario bajo la cual se ejecuta la tarea. Si se omite, la tarea se ejecuta como un usuario no administrativo único de la tarea.

Detalles de las propiedades

affinityInfo

Una pista de localidad que puede ser utilizada por el servicio por lotes para seleccionar un Nodo de Cómputo desde el que iniciar la nueva Tarea.

affinityInfo?: BatchAffinityInfo

Valor de propiedad

BatchAffinityInfo

applicationPackageReferences

Una lista de paquetes que el servicio Batch desplegará en el Nodo de Cómputo antes de ejecutar la línea de comandos. Los paquetes de aplicación se descargan y despliegan en un directorio compartido, no en el directorio de trabajo de Tareas. Por lo tanto, si un paquete referenciado ya está en el Nodo y está actualizado, no se vuelve a descargar; se utiliza la copia existente en el Nodo de Cómputo. Si no se puede instalar un paquete referenciado, por ejemplo porque se ha eliminado o porque la descarga falló, la tarea falla.

applicationPackageReferences?: BatchApplicationPackageReference[]

Valor de propiedad

BatchApplicationPackageReference[]

commandLine

La línea de comandos de la Tarea. Para las tareas multiinstancia, la línea de comandos se ejecuta como la tarea principal, después de que la tarea principal y todas las subtareas hayan terminado de ejecutar la línea de coordenación. La línea de comandos no se ejecuta en un shell y, por tanto, no puede aprovechar las características del shell, como la expansión de variables de entorno. Si quieres aprovechar estas funciones, deberías invocar el shell en la línea de comandos, por ejemplo usando "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

commandLine: string

Valor de propiedad

string

constraints

Las restricciones de ejecución que se aplican a esta tarea. Si no especificas restricciones, el maxTaskRetryCount es el maxTaskRetryCount especificado para el Job, el maxWallClockTime, es infinito y el retentionTime es de 7 días.

constraints?: BatchTaskConstraints

Valor de propiedad

BatchTaskConstraints

containerSettings

Los ajustes del contenedor bajo el cual se ejecuta la tarea. Si el Pool que ejecutará esta Tarea tiene configurado containerConfiguration, esto también debe configurarse. Si el Pool que ejecutará esta tarea no tiene containerConfiguration activado, esto no debe configurarse. Cuando esto se especifica, todos los directorios recursivamente por debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de Azure Batch directorios en el nodo) se mapean en el contenedor, todas las variables del entorno de Tarea se mapean en el contenedor y la línea de comandos de Tarea se ejecuta en el contenedor. Los archivos producidos en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR pueden no reflejarse en el disco anfitrión, lo que significa que las APIs de archivos por lotes no podrán acceder a esos archivos.

containerSettings?: BatchTaskContainerSettings

Valor de propiedad

BatchTaskContainerSettings

dependsOn

Las tareas de las que depende esta tarea. Esta tarea no se programará hasta que todas las tareas de las que depende se hayan completado con éxito. Si alguna de esas tareas falla y agota su número de intentos, esta tarea nunca se programará. Si el Trabajo no tiene usesTaskDependencies configuradas en true, y este elemento está presente, la solicitud falla con el código de error TaskDependenciesNotSpecifiedOnJob.

dependsOn?: BatchTaskDependencies

Valor de propiedad

BatchTaskDependencies

displayName

Un nombre de visualización para la Tarea. 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

environmentSettings

Una lista de ajustes de variables de entorno para la Tarea.

environmentSettings?: EnvironmentSetting[]

Valor de propiedad

EnvironmentSetting[]

exitConditions

Cómo debe responder el servicio por lotes cuando la tarea se complete.

exitConditions?: ExitConditions

Valor de propiedad

ExitConditions

id

Una cadena que identifica de forma única la Tarea dentro del Trabajo. 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 ID preserva mayúsculas y no es insensible a minúsculas (es decir, puede que no tengas dos IDs dentro de un Job que solo difieran por caso).

id: string

Valor de propiedad

string

multiInstanceSettings

Un objeto que indica que la tarea es una tarea multiinstancia y contiene información sobre cómo ejecutarla.

multiInstanceSettings?: MultiInstanceSettings

Valor de propiedad

MultiInstanceSettings

outputFiles

Una lista de archivos que el servicio Batch cargará desde el Nodo de Cómputo tras ejecutar la línea de comandos. Para tareas multiinstancia, los archivos solo se cargarán desde el nodo de cómputo en el que se ejecuta la tarea principal.

outputFiles?: OutputFile[]

Valor de propiedad

OutputFile[]

requiredSlots

El número de espacios de programación que la Tarea requería para ejecutarse. El valor predeterminado es 1. Una tarea solo puede programarse para ejecutarse en un nodo de cómputo si este tiene suficientes espacios libres de planificación disponibles. Para tareas multiinstancia, esto debe ser 1.

requiredSlots?: number

Valor de propiedad

number

resourceFiles

Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. Para tareas multiinstancia, los archivos de recursos solo se descargan al nodo de cómputo en el que se ejecuta la tarea principal. Hay un tamaño máximo para la lista de archivos de recursos. Cuando se supera el tamaño máximo, se producirá un error en la solicitud y el código de error de respuesta será RequestEntityTooLarge. Si esto ocurre, la colección de ResourceFiles debe reducirse en tamaño. Esto se puede lograr mediante archivos de .zip, paquetes de aplicación o contenedores de Docker.

resourceFiles?: ResourceFile[]

Valor de propiedad

ResourceFile[]

userIdentity

La identidad de usuario bajo la cual se ejecuta la tarea. Si se omite, la tarea se ejecuta como un usuario no administrativo único de la tarea.

userIdentity?: UserIdentity

Valor de propiedad

UserIdentity