Task - Update

Referencia

Servicio:: Batch Service

Versión de la API:: 2024-07-01.20.0

Actualiza las propiedades de la tarea especificada.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

Con parámetros opcionales:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.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	Identificador de la tarea que se va a actualizar.
api-version	query	True	string	Versión de la API de cliente.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.

Encabezado de la solicitud

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

Nombre	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 en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; 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 solo se realizará 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 ú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 última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio no se ha modificado desde el momento especificado.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
constraints	TaskConstraints	Restricciones que se aplican a esta tarea. Si se omite, la tarea recibe las restricciones predeterminadas. En el caso de las tareas de varias instancias, la actualización del tiempo de retención solo se aplica a la tarea principal y no a las subtareas.

Respuestas

Nombre	Tipo	Description
200 OK		La solicitud al servicio Batch se realizó correctamente. Encabezados client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Error del servicio Batch.

Nombre

Tipo

Description

200 OK

La solicitud al servicio Batch se realizó correctamente.

Encabezados

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 Microsoft Entra OAuth 2.0

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar la cuenta de usuario

Authorization

Tipo: apiKey
En: header

Ejemplos

Task update

Solicitud de ejemplo

HTTP

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Respuesta de muestra

status code:: 200

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Un elemento de información adicional incluida en una respuesta de error de Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error de Azure Batch.
TaskConstraints	Restricciones de ejecución que se aplicarán a una tarea.
TaskUpdateParameter	Conjunto de cambios que se van a realizar en una tarea.

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 mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

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

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

ErrorMessage

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

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

TaskConstraints

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

Nombre	Tipo	Description
maxTaskRetryCount	integer	Número máximo de veces que se puede reintentar la tarea. El servicio Batch vuelve a intentar 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, podrá volver a intentarlo 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 3 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 reintentos).
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 lo 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ó, desde el momento en que completa 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.

TaskUpdateParameter

Conjunto de cambios que se van a realizar en una tarea.

Nombre	Tipo	Description
constraints	TaskConstraints	Restricciones que se aplican a esta tarea. Si se omite, la tarea recibe las restricciones predeterminadas. En el caso de las tareas de varias instancias, la actualización del tiempo de retención solo se aplica a la tarea principal y no a las subtareas.

Compartir a través de

Task - Update

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Authorization

Ejemplos

Task update

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BatchError

BatchErrorDetail

ErrorMessage

TaskConstraints

TaskUpdateParameter

Recursos adicionales