Job - Disable

Deshabilita el trabajo especificado, lo que impide que se ejecuten nuevas tareas.
El servicio Batch mueve inmediatamente el trabajo al estado de deshabilitación. A continuación, Batch usa el parámetro disableTasks para determinar qué hacer con las tareas que se ejecutan actualmente del trabajo. El trabajo permanece en el estado de deshabilitación hasta que se completa la operación de deshabilitación y todas las tareas se han tratado según la opción disableTasks; a continuación, el trabajo pasa al estado deshabilitado. No se inicia ninguna nueva tarea en el trabajo hasta que vuelva al estado activo. Si intenta deshabilitar un trabajo que se encuentra en cualquier estado distinto de activo, deshabilitado o deshabilitado, se produce un error en la solicitud con el código de estado 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/disable?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 deshabilitar.

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 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 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 la hora especificada.

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 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 Requerido Tipo Description
disableTasks True

DisableJobOption

Qué hacer con las tareas activas asociadas al trabajo.

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

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

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 disable

Sample Request

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



{
  "disableTasks": "terminate"
}

Sample Response

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.

DisableJobOption

Qué hacer con las tareas activas asociadas al trabajo.

ErrorMessage

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

JobDisableParameter

Opciones al deshabilitar 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 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.

DisableJobOption

Qué hacer con las tareas activas asociadas al trabajo.

Nombre Tipo Description
requeue

string

Finalice las tareas en ejecución y vuelva a ponerlas en cola. Las tareas se ejecutarán de nuevo cuando el trabajo esté habilitado.

terminate

string

Finalizar las tareas en ejecución. Las tareas se completarán con failureInfo que indica que finalizaron y no se volverán a ejecutar.

wait

string

Permitir que las tareas en ejecución se completen actualmente.

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.

JobDisableParameter

Opciones al deshabilitar un trabajo.

Nombre Tipo Description
disableTasks

DisableJobOption

Qué hacer con las tareas activas asociadas al trabajo.