Job - Terminate

  • Referencia
Service:
Batch Service
API Version:
2023-11-01.18.0

Finaliza el trabajo especificado y lo marca como completado.
Cuando se recibe una solicitud finalizar trabajo, el servicio Batch establece el trabajo en el estado de finalización. A continuación, el servicio Batch finaliza las tareas en ejecución asociadas al trabajo y ejecuta las tareas de liberación de trabajos necesarias. A continuación, el trabajo pasa al estado completado. Si hay alguna tarea en el trabajo en el estado activo, permanecerán en el estado activo. Una vez finalizado un trabajo, no se pueden agregar nuevas tareas y no se programarán las tareas activas restantes.

POST {batchUrl}/jobs/{jobId}/terminate?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/jobs/{jobId}/terminate?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 se va a finalizar.
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.

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.

Cuerpo de la solicitud

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

Nombre Tipo Description
terminateReason

string

El texto que desea que aparezca como TerminateReason del trabajo. El valor predeterminado es "UserTerminate".

Respuestas

Nombre Tipo Description
202 Accepted

La solicitud al servicio Batch se realizó correctamente.

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

Job terminate

Sample Request

POST account.region.batch.azure.com/jobs/jobId/terminate?api-version=2023-11-01.18.0



{
  "terminateReason": "User supplied termination reason"
}

Sample Response

Status code:
202

Definiciones

Nombre Description
BatchError

Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail

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

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

Opciones al finalizar un trabajo.

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 contiene 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

La información adicional incluida con la respuesta de error.

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.

JobTerminateParameter

Opciones al finalizar un trabajo.

Nombre Tipo Description
terminateReason

string

El texto que desea que aparezca como TerminateReason del trabajo. El valor predeterminado es "UserTerminate".