Task - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtiene información sobre la tarea especificada.
Para las tareas de varias instancias, la información como affinityId, executionInfo y nodeInfo hacen referencia a la tarea principal. Use la API de subtareas de lista para recuperar información sobre las subtareas.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
jobId	path	True	string	Identificador del trabajo que contiene la tarea.
taskId	path	True	string	El identificador de la tarea para obtener información sobre.
api-version	query	True	string	Versión de la API de cliente.
$expand	query		string	Una cláusula $expand de OData.
$select	query		string	Una cláusula $select de OData.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

Media Types: "application/json; odata=minimalmetadata"

Nombre	Requerido	Tipo	Description
client-request-id		string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date		string date-time-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.
If-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.
If-None-Match		string	Valor ETag asociado a la versión del recurso conocido para el cliente. La operación se realizará solo si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.
If-Modified-Since		string date-time-rfc1123	Marca de tiempo que indica la hora de la última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde el momento especificado.
If-Unmodified-Since		string date-time-rfc1123	Marca de tiempo que indica la hora de la última modificación del recurso conocido para el cliente. La operación se realizará solo si el recurso del servicio no se ha modificado desde el momento especificado.

Respuestas

Nombre	Tipo	Description
200 OK	CloudTask	Respuesta que contiene la tarea. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Task get

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Definiciones

Nombre	Description
AccessScope	Recursos de Batch a los que el token concede acceso.
AffinityInformation	Sugerencia de localidad que el servicio Batch puede usar para seleccionar un nodo de proceso en el que iniciar una tarea.
ApplicationPackageReference	Referencia a un paquete que se va a implementar en nodos de proceso.
AuthenticationTokenSettings	La configuración de un token de autenticación que la tarea puede usar para realizar operaciones de servicio de Batch.
AutoUserScope	Ámbito del usuario automático
AutoUserSpecification	Especifica los parámetros del usuario automático que ejecuta una tarea en el servicio Batch.
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
CloudTask	Tarea Azure Batch.
ComputeNodeIdentityReference	Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
ComputeNodeInformation	Información sobre el nodo de proceso en el que se ejecutó una tarea.
ContainerRegistry	Un registro de contenedor privado.
ContainerWorkingDirectory	La ubicación del directorio de trabajo task del contenedor.
DependencyAction	Acción que el servicio Batch realiza en tareas que dependen de esta tarea.
ElevationLevel	Nivel de elevación del usuario.
EnvironmentSetting	Variable de entorno que se va a establecer en un proceso de tarea.
ErrorCategory	Categoría del error.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
ExitCodeMapping	Cómo debe responder el servicio Batch si una tarea sale con un código de salida determinado.
ExitCodeRangeMapping	Un intervalo de códigos de salida y cómo debe responder el servicio Batch a los códigos de salida dentro de ese intervalo.
ExitConditions	Especifica cómo debe responder el servicio Batch cuando se completa la tarea.
ExitOptions	Especifica cómo responde el servicio Batch a una condición de salida determinada.
HttpHeader	Un par nombre-valor de encabezado HTTP
JobAction	Una acción que se realizará en el trabajo que contiene la tarea, si la tarea se completa con la condición de salida especificada y la propiedad onTaskFailed del trabajo es "performExitOptionsJobAction".
MultiInstanceSettings	Configuración que especifica cómo ejecutar una tarea de varias instancias.
NameValuePair	Representa un par nombre-valor.
OutputFile	Especificación para cargar archivos desde un nodo de ejecución de Azure Batch a otra ubicación después de que el servicio Batch haya terminado de ejecutar el proceso de tarea.
OutputFileBlobContainerDestination	Especifica un destino de carga de archivos dentro de un contenedor de Azure Blob Storage.
OutputFileDestination	Destino al que se debe cargar un archivo.
OutputFileUploadCondition	Condiciones en las que se debe cargar un archivo de salida de tarea o un conjunto de archivos.
OutputFileUploadOptions	Detalles sobre una operación de carga de archivos de salida, incluidas las condiciones para realizar la carga.
ResourceFile	Un único archivo o varios archivos que se van a descargar en un nodo de proceso.
TaskConstraints	Restricciones de ejecución que se van a aplicar a una tarea.
TaskContainerExecutionInformation	Contiene información sobre el contenedor que se está ejecutando una tarea.
TaskContainerSettings	Configuración del contenedor de una tarea.
TaskDependencies	Especifica las dependencias de una tarea. Cualquier tarea especificada explícitamente o dentro de un intervalo de dependencias debe completarse antes de que se programe la tarea dependiente.
TaskExecutionInformation	Información sobre la ejecución de una tarea.
TaskExecutionResult	Resultado de la ejecución de la tarea.
TaskFailureInformation	Información sobre un error de tarea.
TaskIdRange	Intervalo de identificadores de tarea de los que puede depender una tarea. Todas las tareas con identificadores en el intervalo deben completarse correctamente antes de que se pueda programar la tarea dependiente.
TaskState	Estado de la tarea.
TaskStatistics	Estadísticas de uso de recursos para una tarea.
UserIdentity	Definición de la identidad de usuario en la que se ejecuta la tarea.

AccessScope

Recursos de Batch a los que el token concede acceso.

Nombre	Tipo	Description
job	string	Concede acceso para realizar todas las operaciones en el trabajo que contiene la tarea.

AffinityInformation

Sugerencia de localidad que el servicio Batch puede usar para seleccionar un nodo de proceso en el que iniciar una tarea.

Nombre	Tipo	Description
affinityId	string	Cadena opaca que representa la ubicación de un nodo de ejecución o una tarea que se ha ejecutado anteriormente. Puede pasar affinityId de un nodo para indicar que esta tarea debe ejecutarse en ese nodo de ejecución. Tenga en cuenta que se trata simplemente de una afinidad flexible. Si el nodo de ejecución de destino está ocupado o no está disponible en el momento en que se programa la tarea, la tarea se programará en otro lugar.

ApplicationPackageReference

Referencia a un paquete que se va a implementar en nodos de proceso.

Nombre	Tipo	Description
applicationId	string	Identificador de la aplicación que se va a implementar. Al crear un grupo, el identificador de aplicación del paquete debe estar completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Versión de la aplicación que se va a implementar. Si se omite, se implementa la versión predeterminada. Si se omite en un grupo y no se especifica ninguna versión predeterminada para esta aplicación, se produce un error en la solicitud con el código de error InvalidApplicationPackageReferences y el código de estado HTTP 409. Si se omite en una tarea y no se especifica ninguna versión predeterminada para esta aplicación, se produce un error de procesamiento previo a la tarea.

AuthenticationTokenSettings

La configuración de un token de autenticación que la tarea puede usar para realizar operaciones de servicio de Batch.

Nombre	Tipo	Description
access	AccessScope[]	Los recursos de Batch a los que el token concede acceso. El token de autenticación concede acceso a un conjunto limitado de operaciones del servicio Batch. Actualmente, el único valor admitido para la propiedad de acceso es "job", que concede acceso a todas las operaciones relacionadas con el trabajo que contiene la tarea.

AutoUserScope

Ámbito del usuario automático

Nombre	Tipo	Description
pool	string	Especifica que la tarea se ejecuta como la cuenta de usuario automático común que se crea en cada nodo de proceso de un grupo.
task	string	Especifica que el servicio debe crear un nuevo usuario para la tarea.

AutoUserSpecification

Especifica los parámetros del usuario automático que ejecuta una tarea en el servicio Batch.

Nombre	Tipo	Description
elevationLevel	ElevationLevel	Nivel de elevación del usuario automático. El valor predeterminado es nonAdmin.
scope	AutoUserScope	Ámbito del usuario automático El valor predeterminado es pool. Si el grupo ejecuta Windows, se debe especificar un valor de Task si se requiere un aislamiento más estricto entre las tareas. Por ejemplo, si la tarea muta el registro de una manera que podría afectar a otras tareas, o si se han especificado certificados en el grupo que no deben ser accesibles por tareas normales, pero deben ser accesibles por StartTasks.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	Información adicional incluida con la respuesta de error.

CloudTask

Tarea Azure Batch.

Nombre	Tipo	Description
affinityInfo	AffinityInformation	Sugerencia de localidad que el servicio Batch puede usar para seleccionar un nodo de proceso en el que iniciar la nueva tarea.
applicationPackageReferences	ApplicationPackageReference[]	Lista de paquetes que el servicio Batch implementará en el nodo de proceso antes de ejecutar la línea de comandos. Los paquetes de aplicación se descargan e implementan en un directorio compartido, no en el directorio de trabajo task. Por lo tanto, si un paquete al que se hace referencia ya está en el nodo y está actualizado, no se vuelve a descargar; se usa la copia existente en el nodo de proceso. Si no se puede instalar un paquete al que se hace referencia, por ejemplo porque se ha eliminado el paquete o porque se produjo un error en la descarga, se produce un error en la tarea.
authenticationTokenSettings	AuthenticationTokenSettings	La configuración de un token de autenticación que la tarea puede usar para realizar operaciones de servicio de Batch. Si se establece esta propiedad, el servicio Batch proporciona la tarea con un token de autenticación que se puede usar para autenticar las operaciones del servicio Batch sin necesidad de una clave de acceso de la cuenta. El token se proporciona a través de la variable de entorno AZ_BATCH_AUTHENTICATION_TOKEN. Las operaciones que la tarea puede llevar a cabo con el token dependen de la configuración. Por ejemplo, una tarea puede solicitar permisos de trabajo para agregar otras tareas al trabajo o comprobar el estado del trabajo o de otras tareas en el trabajo.
commandLine	string	Línea de comandos de la tarea. Para las tareas de varias instancias, la línea de comandos se ejecuta como tarea principal, después de que la tarea principal y todas las subtareas hayan terminado de ejecutar la línea de comandos de coordinació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 desea aprovechar estas características, debe invocar el shell en la línea de comandos, por ejemplo, con "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 tarea) o usar la variable de entorno proporcionada por Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Restricciones de ejecución que se aplican a esta tarea.
containerSettings	TaskContainerSettings	La configuración del contenedor en el que se ejecuta la tarea. Si el grupo que ejecutará esta tarea tiene el conjunto containerConfiguration, también debe establecerse. Si el grupo que ejecutará esta tarea no tiene containerConfiguration establecido, no se debe establecer. Cuando se especifica esto, todos los directorios de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de Azure Batch directorios del nodo) se asignan al contenedor, todas las variables de entorno task se asignan al contenedor y la línea de comandos Task se ejecuta en el contenedor. Es posible que los archivos generados en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR no se reflejen en el disco host, lo que significa que las API de archivos de Batch no podrán acceder a esos archivos.
creationTime	string	Hora de creación de la tarea.
dependsOn	TaskDependencies	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 correctamente. Si alguna de esas tareas produce un error y agota sus recuentos de reintentos, esta tarea nunca se programará.
displayName	string	Nombre para mostrar de la tarea. El nombre para mostrar no debe ser único y puede contener cualquier carácter Unicode hasta una longitud máxima de 1024.
eTag	string	ETag de la tarea. Se trata de una cadena opaca. Puede usarlo para detectar si la tarea ha cambiado entre solicitudes. En concreto, puede pasar la ETag al actualizar una tarea para especificar que los cambios deben surtir efecto solo si nadie más ha modificado la tarea mientras tanto.
environmentSettings	EnvironmentSetting[]	Lista de opciones de configuración de variables de entorno para la tarea.
executionInfo	TaskExecutionInformation	Información sobre la ejecución de la tarea.
exitConditions	ExitConditions	Especifica cómo debe responder el servicio Batch cuando se completa la tarea. Cómo debe responder el servicio Batch cuando se complete la tarea.
id	string	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.
lastModified	string	Hora de la última modificación de la tarea.
multiInstanceSettings	MultiInstanceSettings	Objeto que indica que la tarea es una tarea de varias instancias y contiene información sobre cómo ejecutar la tarea de varias instancias. Las tareas de varias instancias se usan normalmente para admitir tareas MPI. En el caso de MPI, si se produce un error en alguna de las subtareas (por ejemplo, debido a la salida con un código de salida distinto de cero), se produce un error en toda la tarea de varias instancias. A continuación, la tarea de varias instancias se finaliza y se reintenta, hasta su límite de reintento.
nodeInfo	ComputeNodeInformation	Información sobre el nodo de proceso en el que se ejecutó la tarea.
outputFiles	OutputFile[]	Lista de archivos que el servicio Batch cargará desde el nodo de proceso después de ejecutar la línea de comandos. En el caso de las tareas de varias instancias, los archivos solo se cargarán desde el nodo de proceso en el que se ejecuta la tarea principal.
previousState	TaskState	Estado anterior de la tarea. Esta propiedad no se establece si la tarea está en su estado activo inicial.
previousStateTransitionTime	string	Hora en la que la tarea entró en su estado anterior. Esta propiedad no se establece si la tarea está en su estado activo inicial.
requiredSlots	integer	Número de ranuras de programación que requiere la tarea para ejecutarse. El valor predeterminado es 1. Una tarea solo se puede programar para ejecutarse en un nodo de proceso si el nodo tiene suficientes ranuras de programación libres disponibles. Para las tareas de varias instancias, debe ser 1.
resourceFiles	ResourceFile[]	Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. En el caso de las tareas de varias instancias, los archivos de recursos solo se descargarán en el nodo de proceso 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 de tamaño. Esto se puede lograr mediante archivos .zip, paquetes de aplicación o contenedores de Docker.
state	TaskState	Estado actual de la tarea.
stateTransitionTime	string	Hora en la que la tarea entró en su estado actual.
stats	TaskStatistics	Estadísticas de uso de recursos para la tarea.
url	string	Dirección URL de la tarea.
userIdentity	UserIdentity	Identidad de usuario con la que se ejecuta la tarea. Si se omite, la tarea se ejecuta como un usuario no administrativo único para la tarea.

ComputeNodeIdentityReference

Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso de ARM de la identidad asignada por el usuario.

ComputeNodeInformation

Información sobre el nodo de proceso en el que se ejecutó una tarea.

Nombre	Tipo	Description
affinityId	string	Identificador del nodo en el que se ejecutó la tarea, que se puede pasar al agregar una tarea para solicitar que la tarea se programe en este nodo de proceso.
nodeId	string	Identificador del nodo de proceso en el que se ejecutó la tarea.
nodeUrl	string	Dirección URL del nodo de proceso en el que se ejecutó la tarea.
poolId	string	Identificador del grupo en el que se ejecutó la tarea.
taskRootDirectory	string	Directorio raíz de la tarea en el nodo de proceso.
taskRootDirectoryUrl	string	Dirección URL al directorio raíz de la tarea en el nodo de proceso.

ContainerRegistry

Un registro de contenedor privado.

Nombre	Tipo	Description
identityReference	ComputeNodeIdentityReference	Referencia a la identidad asignada por el usuario que se va a usar para acceder a un Azure Container Registry en lugar de nombre de usuario y contraseña. Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
password	string	Contraseña que se va a iniciar sesión en el servidor del Registro.
registryServer	string	Dirección URL del registro. Si se omite, el valor predeterminado es "docker.io".
username	string	Nombre de usuario que se va a iniciar sesión en el servidor del Registro.

ContainerWorkingDirectory

La ubicación del directorio de trabajo task del contenedor.

Nombre	Tipo	Description
containerImageDefault	string	Use el directorio de trabajo definido en la imagen del contenedor. Tenga en cuenta que este directorio no contendrá los archivos de recursos descargados por Batch.
taskWorkingDirectory	string	Use el directorio de trabajo task del servicio Batch estándar, que contendrá los archivos de recursos de tarea rellenados por Batch.

DependencyAction

Acción que el servicio Batch realiza en tareas que dependen de esta tarea.

Nombre	Tipo	Description
block	string	Bloquea las tareas en espera de esta tarea, lo que impide que se programen.
satisfy	string	Satisfacer las tareas que esperan esta tarea; Una vez que se cumplen todas las dependencias, la tarea se programará para ejecutarse.

ElevationLevel

Nivel de elevación del usuario.

Nombre	Tipo	Description
admin	string	El usuario es un usuario con acceso elevado y funciona con permisos de administrador completos.
nonadmin	string	El usuario es un usuario estándar sin acceso elevado.

EnvironmentSetting

Variable de entorno que se va a establecer en un proceso de tarea.

Nombre	Tipo	Description
name	string	Nombre de la variable de entorno.
value	string	Valor de la variable de entorno.

ErrorCategory

Categoría del error.

Nombre	Tipo	Description
servererror	string	El error se debe a un problema interno del servidor.
usererror	string	El error se debe a un problema de usuario, como la configuración incorrecta.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

ExitCodeMapping

Cómo debe responder el servicio Batch si una tarea sale con un código de salida determinado.

Nombre	Tipo	Description
code	integer	Código de salida del proceso.
exitOptions	ExitOptions	Cómo debe responder el servicio Batch si la tarea sale con este código de salida.

ExitCodeRangeMapping

Un intervalo de códigos de salida y cómo debe responder el servicio Batch a los códigos de salida dentro de ese intervalo.

Nombre	Tipo	Description
end	integer	Último código de salida del intervalo.
exitOptions	ExitOptions	Cómo debe responder el servicio Batch si la tarea sale con un código de salida en el intervalo de inicio a fin (inclusivo).
start	integer	El primer código de salida del intervalo.

ExitConditions

Especifica cómo debe responder el servicio Batch cuando se completa la tarea.

Nombre	Tipo	Description
default	ExitOptions	Cómo debe responder el servicio Batch si se produce un error en la tarea con una condición de salida no cubierta por ninguna de las demás propiedades. Este valor se usa si la tarea sale con cualquier código de salida distinto de cero que no aparezca en la colección exitCodes o exitCodeRanges, con un error de preprocesamiento si la propiedad preProcessingError no está presente o con un error de carga de archivos si la propiedad fileUploadError no está presente. Si desea un comportamiento no predeterminado en el código de salida 0, debe enumerarlo explícitamente mediante la colección exitCodes o exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Lista de intervalos de código de salida de tarea y cómo debe responder el servicio Batch.
exitCodes	ExitCodeMapping[]	Una lista de códigos de salida de tareas individuales y cómo el servicio Batch debe responder a ellos.
fileUploadError	ExitOptions	Cómo debe responder el servicio Batch si se produce un error de carga de archivos. Si la tarea salió con un código de salida que se especificó a través de exitCodes o exitCodeRanges y, a continuación, encontró un error de carga de archivo, la acción especificada por el código de salida tiene prioridad.
preProcessingError	ExitOptions	Cómo debe responder el servicio Batch si la tarea no se inicia debido a un error.

ExitOptions

Especifica cómo responde el servicio Batch a una condición de salida determinada.

Nombre	Tipo	Description
dependencyAction	DependencyAction	Acción que el servicio Batch realiza en tareas que dependen de esta tarea. Los valores posibles son "satisfacer" (lo que permite que las tareas dependientes avancen) y "bloquear" (las tareas dependientes continúan esperando). Batch aún no admite la cancelación de tareas dependientes.
jobAction	JobAction	Una acción que se realizará en el trabajo que contiene la tarea, si la tarea se completa con la condición de salida especificada y la propiedad onTaskFailed del trabajo es "performExitOptionsJobAction". El valor predeterminado es none para el código de salida 0 y finalizar para todas las demás condiciones de salida. Si la propiedad onTaskFailed del trabajo es noaction, al especificar esta propiedad se devuelve un error y se produce un error en la solicitud add Task con un error de valor de propiedad no válido; Si va a llamar directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

HttpHeader

Un par nombre-valor de encabezado HTTP

Nombre	Tipo	Description
name	string	Nombre que no distingue mayúsculas de minúsculas del encabezado que se va a usar al cargar archivos de salida
value	string	Valor del encabezado que se va a usar al cargar archivos de salida.

JobAction

Una acción que se realizará en el trabajo que contiene la tarea, si la tarea se completa con la condición de salida especificada y la propiedad onTaskFailed del trabajo es "performExitOptionsJobAction".

Nombre	Tipo	Description
disable	string	Deshabilite el trabajo. Esto equivale a llamar a la API disable Job, con un valor disableTasks de requeue.
none	string	No realice ninguna acción.
terminate	string	Finalice el trabajo. TerminateReason en executionInfo del trabajo se establece en "TaskFailed".

MultiInstanceSettings

Configuración que especifica cómo ejecutar una tarea de varias instancias.

Nombre	Tipo	Description
commonResourceFiles	ResourceFile[]	Lista de archivos que el servicio Batch descargará antes de ejecutar la línea de comandos de coordinación. La diferencia entre los archivos de recursos comunes y los archivos de recursos de tareas es que los archivos de recursos comunes se descargan para todas las subtareas, incluido el principal, mientras que los archivos de recursos de tarea solo se descargan para la principal. Tenga en cuenta también que estos archivos de recursos no se descargan en el directorio de trabajo task, sino que se descargan en el directorio raíz de la tarea (un directorio encima del directorio de trabajo). 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 de tamaño. Esto se puede lograr mediante archivos .zip, paquetes de aplicación o contenedores de Docker.
coordinationCommandLine	string	Línea de comandos que se va a ejecutar en todos los nodos de proceso para permitirles coordinar cuando el servidor principal ejecuta el comando task principal. Una línea de comandos de coordinación típica inicia un servicio en segundo plano y comprueba que el servicio está listo para procesar mensajes entre nodos.
numberOfInstances	integer	Número de nodos de proceso requeridos por la tarea. Si se omite, el valor predeterminado es 1.

NameValuePair

Representa un par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre del par nombre-valor.
value	string	Valor del par nombre-valor.

OutputFile

Especificación para cargar archivos desde un nodo de ejecución de Azure Batch a otra ubicación después de que el servicio Batch haya terminado de ejecutar el proceso de tarea.

Nombre	Tipo	Description
destination	OutputFileDestination	Destino de los archivos de salida.
filePattern	string	Patrón que indica qué archivos se van a cargar. Se admiten rutas de acceso relativas y absolutas. Las rutas de acceso relativas son relativas al directorio de trabajo de la tarea. Se admiten los siguientes caracteres comodín: * coincide con 0 o más caracteres (por ejemplo, el patrón abc* coincidiría con abc o abcdef), ** coincide con cualquier directorio, ? coincide con cualquier carácter individual, [abc] coincide con un carácter entre corchetes y [a-c] coincide con un carácter del intervalo. Los corchetes pueden incluir una negación para que coincida con cualquier carácter no especificado (por ejemplo[!abc] coincide con cualquier carácter, excepto a, b o c). Si un nombre de archivo comienza por "." se omite de forma predeterminada, pero puede coincidir especificando explícitamente (por ejemplo ,.gif no coincidirá con .a.gif, pero ..gif). Un ejemplo sencillo: ***.txt coincide con cualquier archivo que no se inicie en '.' y termine con .txt en el directorio de trabajo de tareas o en cualquier subdirectorio. Si el nombre de archivo contiene un carácter comodín, se puede escapar mediante corchetes (por ejemplo, abc[] coincidiría con un archivo denominado abc). Tenga en cuenta que tanto \ como / se tratan como separadores de directorio en Windows, pero solo / está en Linux. Las variables de entorno (%var% en Windows o $var en Linux) se expanden antes de aplicar el patrón.
uploadOptions	OutputFileUploadOptions	Opciones adicionales para la operación de carga, incluidas las condiciones para realizar la carga.

OutputFileBlobContainerDestination

Especifica un destino de carga de archivos dentro de un contenedor de Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string	Dirección URL del contenedor en Azure Blob Storage en la que se van a cargar los archivos. Si no usa una identidad administrada, la dirección URL debe incluir una firma de acceso compartido (SAS) que conceda permisos de escritura al contenedor.
identityReference	ComputeNodeIdentityReference	Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por containerUrl. La identidad debe tener acceso de escritura al contenedor de Azure Blob Storage
path	string	Blob de destino o directorio virtual dentro del contenedor de Azure Storage. Si filePattern hace referencia a un archivo específico (es decir, no contiene caracteres comodín), la ruta de acceso es el nombre del blob al que cargar ese archivo. Si filePattern contiene uno o varios caracteres comodín (y, por lo tanto, pueden coincidir con varios archivos), la ruta de acceso es el nombre del directorio virtual del blob (que se antepone a cada nombre de blob) al que cargar los archivos. Si se omite, los archivos se cargan en la raíz del contenedor con un nombre de blob que coincida con su nombre de archivo.
uploadHeaders	HttpHeader[]	Lista de pares nombre-valor para los encabezados que se usarán en la carga de archivos de salida. Estos encabezados se especificarán al cargar archivos en Azure Storage. Documento oficial sobre encabezados permitidos al cargar blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Destino al que se debe cargar un archivo.

Nombre	Tipo	Description
container	OutputFileBlobContainerDestination	Ubicación en Azure Blob Storage en la que se cargan los archivos.

OutputFileUploadCondition

Condiciones en las que se debe cargar un archivo de salida de tarea o un conjunto de archivos.

Nombre	Tipo	Description
taskcompletion	string	Cargue los archivos después de que se cierre el proceso de tarea, independientemente del código de salida.
taskfailure	string	Cargue los archivos solo después de que el proceso de tarea se cierre con un código de salida distinto de cero.
tasksuccess	string	Cargue los archivos solo después de que el proceso de tarea salga con un código de salida de 0.

OutputFileUploadOptions

Detalles sobre una operación de carga de archivos de salida, incluidas las condiciones para realizar la carga.

Nombre	Tipo	Description
uploadCondition	OutputFileUploadCondition	Condiciones en las que se debe cargar el archivo de salida de la tarea o el conjunto de archivos. El valor predeterminado es taskcompletion.

ResourceFile

Un único archivo o varios archivos que se van a descargar en un nodo de proceso.

Nombre	Tipo	Description
autoStorageContainerName	string	El nombre del contenedor de almacenamiento en la cuenta de almacenamiento automática. Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas.
blobPrefix	string	Prefijo de blob que se va a usar al descargar blobs de un contenedor de Azure Storage. Solo se descargarán los blobs cuyos nombres comiencen por el prefijo especificado. La propiedad solo es válida cuando se usa autoStorageContainerName o storageContainerUrl. Este prefijo puede ser un nombre de archivo parcial o un subdirectorio. Si no se especifica un prefijo, se descargarán todos los archivos del contenedor.
fileMode	string	Atributo de modo de permiso de archivo en formato octal. Esta propiedad solo se aplica a los archivos que se descargan en nodos de proceso de Linux. Se omitirá si se especifica para un resourceFile que se descargará en un nodo de proceso de Windows. Si no se especifica esta propiedad para un nodo de ejecución de Linux, se aplica un valor predeterminado de 0770 al archivo.
filePath	string	Ubicación en el nodo de proceso al que se van a descargar los archivos, en relación con el directorio de trabajo de la tarea. Si se especifica la propiedad httpUrl, se requiere filePath y describe la ruta de acceso en la que se descargará el archivo, incluido el nombre de archivo. De lo contrario, si se especifica la propiedad autoStorageContainerName o storageContainerUrl, filePath es opcional y es el directorio al que descargar los archivos. En el caso de que filePath se use como directorio, cualquier estructura de directorios que ya esté asociada a los datos de entrada se conservará en su totalidad y se anexará al directorio filePath especificado. La ruta de acceso relativa especificada no puede interrumpir el directorio de trabajo de la tarea (por ejemplo, mediante "..").
httpUrl	string	La dirección URL del archivo que se va a descargar. Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas. Si la dirección URL apunta a Azure Blob Storage, debe ser legible desde los nodos de proceso. Hay tres maneras de obtener esta dirección URL para un blob en Azure Storage: incluya una firma de acceso compartido (SAS) que conceda permisos de lectura en el blob, use una identidad administrada con permiso de lectura o establezca la ACL para el blob o su contenedor para permitir el acceso público.
identityReference	ComputeNodeIdentityReference	Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por storageContainerUrl o httpUrl Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
storageContainerUrl	string	Dirección URL del contenedor de blobs en Azure Blob Storage. Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas. Esta dirección URL debe ser legible y enumerable desde los nodos de proceso. Hay tres maneras de obtener esta dirección URL para un contenedor en Azure Storage: incluya una firma de acceso compartido (SAS) que conceda permisos de lectura y lista en el contenedor, use una identidad administrada con permisos de lectura y lista, o establezca la ACL para que el contenedor permita el acceso público.

TaskConstraints

Restricciones de ejecución que se van a aplicar a una tarea.

Nombre	Tipo	Description
maxTaskRetryCount	integer	Número máximo de veces que se puede reintentar la tarea. El servicio Batch reintenta una tarea si su código de salida es distinto de cero. Tenga en cuenta que este valor controla específicamente el número de reintentos para el ejecutable task debido a un código de salida distinto de cero. El servicio Batch probará la tarea una vez y, a continuación, puede reintentar hasta este límite. Por ejemplo, si el número máximo de reintentos es 3, Batch intenta la tarea hasta 4 veces (un intento inicial y tres reintentos). Si el número máximo de reintentos es 0, el servicio Batch no vuelve a intentar la tarea después del primer intento. Si el número máximo de reintentos es -1, el servicio Batch reintenta la tarea sin límite, pero esto no se recomienda para una tarea de inicio ni para ninguna tarea. El valor predeterminado es 0 (sin ningún reintento).
maxWallClockTime	string	Tiempo máximo transcurrido que se puede ejecutar la tarea, medido desde el momento en que se inicia la tarea. Si la tarea no se completa dentro del límite de tiempo, el servicio Batch la finaliza. Si no se especifica, no hay ningún límite de tiempo durante cuánto tiempo se puede ejecutar la tarea.
retentionTime	string	El tiempo mínimo para conservar el directorio Task en el nodo de proceso donde se ejecutó, a partir del momento en que finaliza la ejecución. Después de este tiempo, el servicio Batch puede eliminar el directorio Task y todo su contenido. El valor predeterminado es 7 días, es decir, el directorio Task se conservará durante 7 días a menos que se quite el nodo de proceso o se elimine el trabajo.

TaskContainerExecutionInformation

Contiene información sobre el contenedor que se está ejecutando una tarea.

Nombre	Tipo	Description
containerId	string	La ID del contenedor.
error	string	Información detallada del error sobre el contenedor. Esta es la cadena de error detallada del servicio Docker, si está disponible. Es equivalente al campo de error devuelto por "docker inspect".
state	string	Estado del contenedor. Este es el estado del contenedor según el servicio Docker. Es equivalente al campo de estado devuelto por "docker inspect".

TaskContainerSettings

Configuración del contenedor de una tarea.

Nombre	Tipo	Description
containerRunOptions	string	Opciones adicionales para el comando container create. Estas opciones adicionales se proporcionan como argumentos para el comando "docker create", además de los controlados por el servicio Batch.
imageName	string	Imagen que se va a usar para crear el contenedor en el que se ejecutará la tarea. Se trata de la referencia de imagen completa, como se especificaría en "docker pull". Si no se proporciona ninguna etiqueta como parte del nombre de la imagen, la etiqueta ":latest" se usa como valor predeterminado.
registry	ContainerRegistry	Registro privado que contiene la imagen de contenedor. Esta configuración se puede omitir si ya se proporcionó en la creación del grupo.
workingDirectory	ContainerWorkingDirectory	Ubicación del directorio de trabajo de la tarea de contenedor. El valor predeterminado es "taskWorkingDirectory".

TaskDependencies

Especifica las dependencias de una tarea. Cualquier tarea especificada explícitamente o dentro de un intervalo de dependencias debe completarse antes de que se programe la tarea dependiente.

Nombre	Tipo	Description
taskIdRanges	TaskIdRange[]	Lista de intervalos de id. de tarea de los que depende esta tarea. Todas las tareas de todos los intervalos deben completarse correctamente antes de que se pueda programar la tarea dependiente.
taskIds	string[]	Lista de identificadores de tarea de los que depende esta tarea. Todas las tareas de esta lista deben completarse correctamente antes de que se pueda programar la tarea dependiente. La colección taskIds está limitada a 64000 caracteres en total (es decir, la longitud combinada de todos los identificadores de tarea). Si la colección taskIds supera la longitud máxima, se produce un error en la solicitud Agregar tarea con el código de error TaskDependencyListTooLong. En este caso, considere la posibilidad de usar los intervalos de id. de tarea en su lugar.

TaskExecutionInformation

Información sobre la ejecución de una tarea.

Nombre	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Información sobre el contenedor en el que se ejecuta la tarea. Esta propiedad solo se establece si la tarea se ejecuta en un contexto de contenedor.
endTime	string	Hora a la que se completó la tarea. Esta propiedad solo se establece si la tarea está en estado Completado.
exitCode	integer	Código de salida del programa especificado en la línea de comandos task. Esta propiedad solo se establece si la tarea está en estado completado. En general, el código de salida de un proceso refleja la convención específica implementada por el desarrollador de aplicaciones para ese proceso. Si usa el valor de código de salida para tomar decisiones en el código, asegúrese de que conoce la convención de código de salida usada por el proceso de aplicación. Sin embargo, si el servicio Batch finaliza la tarea (debido al tiempo de espera o a la finalización del usuario a través de la API), es posible que vea un código de salida definido por el sistema operativo.
failureInfo	TaskFailureInformation	Información que describe el error de tarea, si existe. Esta propiedad solo se establece si la tarea está en estado completado y encontró un error.
lastRequeueTime	string	La hora más reciente en la que el servicio Batch ha vuelto a poner en cola la tarea como resultado de una solicitud de usuario. Esta propiedad solo se establece si requeueCount es distinto de cero.
lastRetryTime	string	La hora más reciente en la que se inició la ejecución de un reintento de la tarea. Este elemento solo está presente si se reintentó la tarea (es decir, retryCount es distinto de cero). Si está presente, suele ser el mismo que startTime, pero puede ser diferente si la tarea se ha reiniciado por motivos distintos del reintento; por ejemplo, si el nodo de proceso se ha reiniciado durante un reintento, se actualiza startTime, pero lastRetryTime no.
requeueCount	integer	Número de veces que el servicio Batch ha puesto en cola la tarea como resultado de una solicitud de usuario. Cuando el usuario quita nodos de proceso de un grupo (mediante el cambio de tamaño o reducción del grupo) o cuando el trabajo está deshabilitado, el usuario puede especificar que las tareas en ejecución en los nodos de proceso se vuelvan a poner en cola para su ejecución. Este recuento realiza un seguimiento de cuántas veces se ha vuelto a poner en cola la tarea por estos motivos.
result	TaskExecutionResult	Resultado de la ejecución de la tarea. Si el valor es "failed", los detalles del error se pueden encontrar en la propiedad failureInfo.
retryCount	integer	Número de veces que el servicio Batch ha reintentado la tarea. Los errores de la aplicación de tareas (código de salida distinto de cero) se reintentan, se reintentan los errores de procesamiento previo (no se pudo ejecutar la tarea) y no se reintentan los errores de carga de archivos. El servicio Batch reintentará la tarea hasta el límite especificado por las restricciones.
startTime	string	Hora en la que se inició la ejecución de la tarea. "En ejecución" corresponde al estado en ejecución, por lo que si la tarea especifica archivos de recursos o paquetes, la hora de inicio refleja la hora en la que la tarea comenzó a descargar o implementarlas. Si se ha reiniciado o reintentado la tarea, esta es la hora más reciente en la que se inició la ejecución de la tarea. Esta propiedad solo está presente para las tareas que están en estado en ejecución o completado.

TaskExecutionResult

Resultado de la ejecución de la tarea.

Nombre	Tipo	Description
failure	string	Se produjo un error durante el procesamiento de la tarea. Es posible que el error se haya producido antes de que se inicie el proceso de tarea, mientras se estaba ejecutando el proceso de tarea o después de salir del proceso de tarea.
success	string	La tarea se ejecutó correctamente.

TaskFailureInformation

Información sobre un error de tarea.

Nombre	Tipo	Description
category	ErrorCategory	Categoría del error de tarea.
code	string	Identificador del error de tarea. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	NameValuePair[]	Lista de detalles adicionales relacionados con el error.
message	string	Mensaje que describe el error de tarea, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

TaskIdRange

Intervalo de identificadores de tarea de los que puede depender una tarea. Todas las tareas con identificadores en el intervalo deben completarse correctamente antes de que se pueda programar la tarea dependiente.

Nombre	Tipo	Description
end	integer	El último identificador de tarea del intervalo.
start	integer	El primer identificador de tarea del intervalo.

TaskState

Estado de la tarea.

Nombre	Tipo	Description
active	string	La tarea se pone en cola y se puede ejecutar, pero no está asignada actualmente a un nodo de proceso. Una tarea entra en este estado cuando se crea, cuando se habilita después de deshabilitarse o cuando está esperando un reintento después de una ejecución errónea.
completed	string	La tarea ya no es apta para ejecutarse, normalmente porque la tarea ha finalizado correctamente o la tarea ha finalizado sin éxito y ha agotado su límite de reintento. Una tarea también se marca como completada si se produjo un error al iniciar la tarea o cuando se ha terminado la tarea.
preparing	string	La tarea se ha asignado a un nodo de proceso, pero espera a que se complete una tarea de preparación de trabajo necesaria en el nodo de proceso. Si la tarea de preparación del trabajo se realiza correctamente, la tarea pasará a ejecutarse. Si se produce un error en la tarea de preparación del trabajo, la tarea volverá a activa y será apta para asignarse a otro nodo de proceso.
running	string	La tarea se ejecuta en un nodo de proceso. Esto incluye la preparación de nivel de tarea, como la descarga de archivos de recursos o la implementación de paquetes especificados en la tarea; no significa necesariamente que la línea de comandos task haya empezado a ejecutarse.

TaskStatistics

Estadísticas de uso de recursos para una tarea.

Nombre	Tipo	Description
kernelCPUTime	string	Tiempo total de CPU del modo kernel (sumado en todos los núcleos y todos los nodos de proceso) consumidos por la tarea.
lastUpdateTime	string	Hora en la que se actualizaron por última vez las estadísticas. Todas las estadísticas se limitan al intervalo entre startTime y lastUpdateTime.
readIOGiB	number	El total de gibibytes leídos del disco por la tarea.
readIOps	integer	Número total de operaciones de lectura de disco realizadas por la tarea.
startTime	string	Hora de inicio del intervalo de tiempo cubierto por las estadísticas.
url	string	Dirección URL de las estadísticas.
userCPUTime	string	Tiempo total de CPU del modo de usuario (sumado en todos los núcleos y todos los nodos de proceso) consumidos por la tarea.
waitTime	string	Tiempo de espera total de la tarea. El tiempo de espera de una tarea se define como el tiempo transcurrido entre la creación de la tarea y el inicio de la ejecución de la tarea. (Si se reintenta la tarea debido a errores, el tiempo de espera es el tiempo de ejecución de la tarea más reciente).
wallClockTime	string	Tiempo total del reloj de la tarea. La hora del reloj de pared es el tiempo transcurrido desde el momento en que la tarea comenzó a ejecutarse en un nodo de proceso a cuando finalizó (o hasta la última vez que se actualizaron las estadísticas, si la tarea no había terminado por entonces). Si se reintentó la tarea, esto incluye la hora del reloj de todos los reintentos de la tarea.
writeIOGiB	number	El total de gibibytes escritos en el disco por la tarea.
writeIOps	integer	Número total de operaciones de escritura de disco realizadas por la tarea.

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea.

Nombre	Tipo	Description
autoUser	AutoUserSpecification	Usuario automático en el que se ejecuta la tarea. Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.
username	string	Nombre de la identidad de usuario en la que se ejecuta la tarea. Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.