BatchJobCreateOptions interface

Paquete:

@azure-rest/batch

Parámetros para crear un trabajo de Azure Batch.

Propiedades

allowTaskPreemption	Si las tareas de este trabajo pueden ser adelantadas por otros trabajos de prioridad alta. (Esta propiedad no está disponible de forma predeterminada. Póngase en contacto con el soporte técnico para obtener más información) Si el valor se establece en True, otros trabajos de alta prioridad enviados al sistema tendrán prioridad y podrán volver a poner en cola las tareas de este trabajo. Puede actualizar allowTaskPreemption de un trabajo después de que se haya creado mediante la API de trabajo de actualización.
commonEnvironmentSettings	Lista de valores comunes de variables de entorno. Estas variables de entorno se establecen para todas las tareas del trabajo (incluidos el Administrador de trabajos, la preparación del trabajo y las tareas de liberación de trabajos). Las tareas individuales pueden invalidar una configuración de entorno especificada aquí especificando el mismo nombre de configuración con un valor diferente.
constraints	Restricciones de ejecución para el trabajo.
displayName	Nombre para mostrar del trabajo. El nombre para mostrar no debe ser único y puede contener caracteres Unicode de hasta una longitud máxima de 1024.
id	Cadena que identifica de forma única el trabajo 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 dentro de una cuenta que solo difiere por caso).
jobManagerTask	Detalles de una tarea del Administrador de trabajos que se va a iniciar cuando se inicia el trabajo. Si el trabajo no especifica una tarea del Administrador de trabajos, el usuario debe agregar explícitamente tareas al trabajo. Si el trabajo especifica una tarea del Administrador de trabajos, el servicio Batch crea la tarea administrador de trabajos cuando se crea el trabajo y intentará programar la tarea administrador de trabajos antes de programar otras tareas en el trabajo. El propósito típico de la tarea del Administrador de trabajos es controlar o supervisar la ejecución del trabajo, por ejemplo, decidir qué tareas adicionales ejecutar, determinar cuándo se completa el trabajo, etc. (Sin embargo, una tarea del Administrador de trabajos no está restringida a estas actividades, es una tarea totalmente completa en el sistema y realiza las acciones necesarias para el trabajo). Por ejemplo, una tarea del Administrador de trabajos podría descargar un archivo especificado como parámetro, analizar el contenido de ese archivo y enviar tareas adicionales en función de ese contenido.
jobPreparationTask	Tarea de preparación del trabajo. Si un trabajo tiene una tarea de preparación de trabajos, el servicio Batch ejecutará la tarea de preparación del trabajo en un nodo antes de iniciar las tareas de ese trabajo en ese nodo de proceso.
jobReleaseTask	Tarea Liberación del trabajo. No se puede especificar una tarea de liberación de trabajos sin especificar también una tarea de preparación del trabajo. El servicio Batch ejecuta la tarea de liberación de trabajos en los nodos que han ejecutado la tarea de preparación del trabajo. El propósito principal de la tarea de liberación de trabajos es deshacer los cambios en los nodos de proceso realizados por la tarea de preparación del trabajo. Las actividades de ejemplo incluyen la eliminación de archivos locales o el apagado de servicios que se iniciaron como parte de la preparación del trabajo.
maxParallelTasks	Número máximo de tareas que se pueden ejecutar en paralelo para el trabajo. (Esta propiedad no está disponible de forma predeterminada. Póngase en contacto con el soporte técnico para obtener más información) El valor de maxParallelTasks debe ser -1 o mayor que 0 si se especifica. Si no se especifica, el valor predeterminado es -1, lo que significa que no hay ningún límite para el número de tareas que se pueden ejecutar a la vez. Puede actualizar los maxParallelTasks de un trabajo después de que se haya creado mediante la API de trabajo de actualización.
metadata	Lista de pares nombre-valor asociados al trabajo como metadatos. El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.
networkConfiguration	(Esta propiedad no está disponible de forma predeterminada. Póngase en contacto con el soporte para obtener más información) La configuración de red para el trabajo.
onAllTasksComplete	La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo estén en estado completado. Tenga en cuenta que si un trabajo no contiene tareas, todas las tareas se consideran completas. Por lo tanto, esta opción se usa con más frecuencia con una tarea del Administrador de trabajos; Si desea usar la terminación automática del trabajo sin un Administrador de trabajos, debe establecer inicialmente onAllTasksComplete en noaction y actualizar las propiedades job para establecer onAllTasksComplete para finalizarjob una vez que haya terminado de agregar Tareas. El valor predeterminado es noaction. Valores posibles: "noaction", "terminatejob"
onTaskFailure	La acción que debe realizar el servicio Batch cuando se produce un error en cualquier tarea del trabajo. Se considera que se ha producido un error en una tarea si tiene un errorInfo. Se establece un errorInfo si la tarea se completa con un código de salida distinto de cero después de agotar su recuento de reintentos, o si se produjo un error al iniciar la tarea, por ejemplo debido a un error de descarga del archivo de recursos. El valor predeterminado es noaction. Valores posibles: "noaction", "performexitoptionsjobaction"
poolInfo	Grupo en el que el servicio Batch ejecuta las tareas del trabajo.
priority	Prioridad del trabajo. Los valores de prioridad pueden oscilar entre -1000 y 1000, y -1000 ser la prioridad más baja y 1000 es la prioridad más alta. El valor predeterminado es 0.
usesTaskDependencies	Si las tareas del trabajo pueden definir dependencias entre sí. El valor predeterminado es false.

Detalles de las propiedades

allowTaskPreemption

Si las tareas de este trabajo pueden ser adelantadas por otros trabajos de prioridad alta. (Esta propiedad no está disponible de forma predeterminada. Póngase en contacto con el soporte técnico para obtener más información) Si el valor se establece en True, otros trabajos de alta prioridad enviados al sistema tendrán prioridad y podrán volver a poner en cola las tareas de este trabajo. Puede actualizar allowTaskPreemption de un trabajo después de que se haya creado mediante la API de trabajo de actualización.

allowTaskPreemption?: boolean

Valor de propiedad

boolean

commonEnvironmentSettings

Lista de valores comunes de variables de entorno. Estas variables de entorno se establecen para todas las tareas del trabajo (incluidos el Administrador de trabajos, la preparación del trabajo y las tareas de liberación de trabajos). Las tareas individuales pueden invalidar una configuración de entorno especificada aquí especificando el mismo nombre de configuración con un valor diferente.

commonEnvironmentSettings?: EnvironmentSetting[]

Valor de propiedad

EnvironmentSetting[]

constraints

Restricciones de ejecución para el trabajo.

constraints?: BatchJobConstraints

Valor de propiedad

BatchJobConstraints

displayName

Nombre para mostrar del trabajo. 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

id

Cadena que identifica de forma única el trabajo 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 dentro de una cuenta que solo difiere por caso).

id: string

Valor de propiedad

string

jobManagerTask

Detalles de una tarea del Administrador de trabajos que se va a iniciar cuando se inicia el trabajo. Si el trabajo no especifica una tarea del Administrador de trabajos, el usuario debe agregar explícitamente tareas al trabajo. Si el trabajo especifica una tarea del Administrador de trabajos, el servicio Batch crea la tarea administrador de trabajos cuando se crea el trabajo y intentará programar la tarea administrador de trabajos antes de programar otras tareas en el trabajo. El propósito típico de la tarea del Administrador de trabajos es controlar o supervisar la ejecución del trabajo, por ejemplo, decidir qué tareas adicionales ejecutar, determinar cuándo se completa el trabajo, etc. (Sin embargo, una tarea del Administrador de trabajos no está restringida a estas actividades, es una tarea totalmente completa en el sistema y realiza las acciones necesarias para el trabajo). Por ejemplo, una tarea del Administrador de trabajos podría descargar un archivo especificado como parámetro, analizar el contenido de ese archivo y enviar tareas adicionales en función de ese contenido.

jobManagerTask?: BatchJobManagerTask

Valor de propiedad

BatchJobManagerTask

jobPreparationTask

Tarea de preparación del trabajo. Si un trabajo tiene una tarea de preparación de trabajos, el servicio Batch ejecutará la tarea de preparación del trabajo en un nodo antes de iniciar las tareas de ese trabajo en ese nodo de proceso.

jobPreparationTask?: BatchJobPreparationTask

Valor de propiedad

BatchJobPreparationTask

jobReleaseTask

Tarea Liberación del trabajo. No se puede especificar una tarea de liberación de trabajos sin especificar también una tarea de preparación del trabajo. El servicio Batch ejecuta la tarea de liberación de trabajos en los nodos que han ejecutado la tarea de preparación del trabajo. El propósito principal de la tarea de liberación de trabajos es deshacer los cambios en los nodos de proceso realizados por la tarea de preparación del trabajo. Las actividades de ejemplo incluyen la eliminación de archivos locales o el apagado de servicios que se iniciaron como parte de la preparación del trabajo.

jobReleaseTask?: BatchJobReleaseTask

Valor de propiedad

BatchJobReleaseTask

maxParallelTasks

Número máximo de tareas que se pueden ejecutar en paralelo para el trabajo. (Esta propiedad no está disponible de forma predeterminada. Póngase en contacto con el soporte técnico para obtener más información) El valor de maxParallelTasks debe ser -1 o mayor que 0 si se especifica. Si no se especifica, el valor predeterminado es -1, lo que significa que no hay ningún límite para el número de tareas que se pueden ejecutar a la vez. Puede actualizar los maxParallelTasks de un trabajo después de que se haya creado mediante la API de trabajo de actualización.

maxParallelTasks?: number

Valor de propiedad

number

metadata

Lista de pares nombre-valor asociados al trabajo 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[]

networkConfiguration

(Esta propiedad no está disponible de forma predeterminada. Póngase en contacto con el soporte para obtener más información) La configuración de red para el trabajo.

networkConfiguration?: BatchJobNetworkConfiguration

Valor de propiedad

BatchJobNetworkConfiguration

onAllTasksComplete

La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo estén en estado completado. Tenga en cuenta que si un trabajo no contiene tareas, todas las tareas se consideran completas. Por lo tanto, esta opción se usa con más frecuencia con una tarea del Administrador de trabajos; Si desea usar la terminación automática del trabajo sin un Administrador de trabajos, debe establecer inicialmente onAllTasksComplete en noaction y actualizar las propiedades job para establecer onAllTasksComplete para finalizarjob una vez que haya terminado de agregar Tareas. El valor predeterminado es noaction.

Valores posibles: "noaction", "terminatejob"

onAllTasksComplete?: string

Valor de propiedad

string

onTaskFailure

La acción que debe realizar el servicio Batch cuando se produce un error en cualquier tarea del trabajo. Se considera que se ha producido un error en una tarea si tiene un errorInfo. Se establece un errorInfo si la tarea se completa con un código de salida distinto de cero después de agotar su recuento de reintentos, o si se produjo un error al iniciar la tarea, por ejemplo debido a un error de descarga del archivo de recursos. El valor predeterminado es noaction.

Valores posibles: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Valor de propiedad

string

poolInfo

Grupo en el que el servicio Batch ejecuta las tareas del trabajo.

poolInfo: BatchPoolInfo

Valor de propiedad

BatchPoolInfo

priority

Prioridad del trabajo. Los valores de prioridad pueden oscilar entre -1000 y 1000, y -1000 ser la prioridad más baja y 1000 es la prioridad más alta. El valor predeterminado es 0.

priority?: number

Valor de propiedad

number

usesTaskDependencies

Si las tareas del trabajo pueden definir dependencias entre sí. El valor predeterminado es false.

usesTaskDependencies?: boolean

Valor de propiedad

boolean