Compartir a través de


TaskOperations Clase

Operaciones taskOperations.

No debe crear instancias directamente de esta clase, sino crear una instancia de cliente que la creará automáticamente y la asociará como atributo.

Herencia
builtins.object
TaskOperations

Constructor

TaskOperations(client, config, serializer, deserializer)

Parámetros

client
Requerido

Cliente para solicitudes de servicio.

config
Requerido

Configuración del cliente de servicio.

serializer
Requerido

Serializador de modelo de objetos.

deserializer
Requerido

Deserializador de modelo de objetos.

Variables

api_version

La versión de API que se usará para la solicitud. Valor constante: "2023-05-01.17.0".

Métodos

add

Agrega una tarea al trabajo especificado.

La duración máxima de una tarea a partir de la finalización es de 180 días. Si una tarea no se ha completado en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.

add_collection

Agrega una colección de tareas al trabajo especificado.

Tenga en cuenta que cada tarea debe tener un identificador único. Es posible que el servicio Batch no devuelva los resultados de cada tarea en el mismo orden en que se enviaron las tareas en esta solicitud. Si el servidor agota el tiempo de espera o la conexión se cierra durante la solicitud, es posible que la solicitud se haya procesado parcialmente o totalmente, o no en absoluto. En tales casos, el usuario debe volver a emitir la solicitud. Tenga en cuenta que el usuario debe controlar correctamente los errores al volver a emitir una solicitud. Por ejemplo, debe usar los mismos identificadores de tarea durante un reintento para que, si la operación anterior se realizó correctamente, el reintento no creará tareas adicionales de forma inesperada. Si la respuesta contiene tareas que no se pudieron agregar, un cliente puede volver a intentar la solicitud. En un reintento, es más eficaz volver a enviar solo las tareas que no se pudieron agregar y omitir las tareas que se agregaron correctamente en el primer intento. La duración máxima de una tarea desde la suma hasta la finalización es de 180 días. Si una tarea no se ha completado en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.

delete

Elimina una tarea del trabajo especificado.

Cuando se elimina una tarea, también se eliminan todos los archivos de su directorio en el nodo de proceso donde se ejecutó (independientemente del tiempo de retención). En el caso de las tareas de varias instancias, la operación eliminar tarea se aplica sincrónicamente a la tarea principal; Las subtareas y sus archivos se eliminan asincrónicamente en segundo plano.

get

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.

list

Enumera todas las tareas asociadas al trabajo especificado.

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.

list_subtasks

Enumera todas las subtareas asociadas a la tarea de varias instancias especificada.

Si la tarea no es una tarea de varias instancias, devuelve una colección vacía.

reactivate

Reactiva una tarea, lo que le permite volver a ejecutarse incluso si se ha agotado su recuento de reintentos.

La reactivación hace que una tarea sea apta para reintentarse de nuevo hasta su número máximo de reintentos. El estado de la tarea se cambia a activo. Como la tarea ya no está en el estado completado, ningún código de salida o información de error anterior ya no está disponible después de la reactivación. Cada vez que se reactiva una tarea, su recuento de reintentos se restablece a 0. Se producirá un error en la reactivación de las tareas que no se hayan completado o que se hayan completado correctamente (con un código de salida de 0). Además, se producirá un error si el trabajo se ha completado (o está finalizando o eliminando).

terminate

Finaliza la tarea especificada.

Cuando se ha terminado la tarea, pasa al estado completado. En el caso de las tareas de varias instancias, la operación finalizar tarea se aplica de forma sincrónica a la tarea principal; Las subtareas se finalizan de forma asincrónica en segundo plano.

update

Novedades las propiedades de la tarea especificada.

add

Agrega una tarea al trabajo especificado.

La duración máxima de una tarea a partir de la finalización es de 180 días. Si una tarea no se ha completado en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo al que se va a agregar la tarea.

task
TaskAddParameter
Requerido

Tarea que se va a agregar.

task_add_options
TaskAddOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

add_collection

Agrega una colección de tareas al trabajo especificado.

Tenga en cuenta que cada tarea debe tener un identificador único. Es posible que el servicio Batch no devuelva los resultados de cada tarea en el mismo orden en que se enviaron las tareas en esta solicitud. Si el servidor agota el tiempo de espera o la conexión se cierra durante la solicitud, es posible que la solicitud se haya procesado parcialmente o totalmente, o no en absoluto. En tales casos, el usuario debe volver a emitir la solicitud. Tenga en cuenta que el usuario debe controlar correctamente los errores al volver a emitir una solicitud. Por ejemplo, debe usar los mismos identificadores de tarea durante un reintento para que, si la operación anterior se realizó correctamente, el reintento no creará tareas adicionales de forma inesperada. Si la respuesta contiene tareas que no se pudieron agregar, un cliente puede volver a intentar la solicitud. En un reintento, es más eficaz volver a enviar solo las tareas que no se pudieron agregar y omitir las tareas que se agregaron correctamente en el primer intento. La duración máxima de una tarea desde la suma hasta la finalización es de 180 días. Si una tarea no se ha completado en un plazo de 180 días después de agregarla, el servicio Batch finalizará y se dejará en cualquier estado en el que estuviera en ese momento.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo al que se va a agregar la colección de tareas.

value
list of TaskAddParameter
Requerido

Colección de tareas que se van a agregar. El tamaño total serializado de esta colección debe ser inferior a 4 MB. Si es mayor que 4 MB (por ejemplo, si cada tarea tiene 100 de archivos de recursos o variables de entorno), se producirá un error en la solicitud con el código "RequestBodyTooLarge" y se volverá a intentar con menos tareas.

task_add_collection_options
TaskAddCollectionOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

threads
int
valor predeterminado: 0

número de subprocesos que se usarán en paralelo al agregar tareas. Si se especifica y mayor que 0, iniciará subprocesos adicionales para enviar solicitudes y esperará a que finalicen. De lo contrario, enviará solicitudes add_collection secuencialmente en el subproceso principal.

Devoluciones

TaskAddCollectionResult o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

azure.batch.custom.CreateTasksErrorException

delete

Elimina una tarea del trabajo especificado.

Cuando se elimina una tarea, también se eliminan todos los archivos de su directorio en el nodo de proceso donde se ejecutó (independientemente del tiempo de retención). En el caso de las tareas de varias instancias, la operación eliminar tarea se aplica sincrónicamente a la tarea principal; Las subtareas y sus archivos se eliminan asincrónicamente en segundo plano.

delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo del que se va a eliminar la tarea.

task_id
str
Requerido

Identificador de la tarea que se va a eliminar.

task_delete_options
TaskDeleteOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

get

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(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que contiene la tarea.

task_id
str
Requerido

El identificador de la tarea para obtener información sobre.

task_get_options
TaskGetOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

CloudTask o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

list

Enumera todas las tareas asociadas al trabajo especificado.

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.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo.

task_list_options
TaskListOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Iterador como una instancia de CloudTask

Tipo de valor devuelto

Excepciones

list_subtasks

Enumera todas las subtareas asociadas a la tarea de varias instancias especificada.

Si la tarea no es una tarea de varias instancias, devuelve una colección vacía.

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo.

task_id
str
Requerido

Identificador de la tarea.

task_list_subtasks_options
TaskListSubtasksOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

CloudTaskListSubtasksResult o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

reactivate

Reactiva una tarea, lo que le permite volver a ejecutarse incluso si se ha agotado su recuento de reintentos.

La reactivación hace que una tarea sea apta para reintentarse de nuevo hasta su número máximo de reintentos. El estado de la tarea se cambia a activo. Como la tarea ya no está en el estado completado, ningún código de salida o información de error anterior ya no está disponible después de la reactivación. Cada vez que se reactiva una tarea, su recuento de reintentos se restablece a 0. Se producirá un error en la reactivación de las tareas que no se hayan completado o que se hayan completado correctamente (con un código de salida de 0). Además, se producirá un error si el trabajo se ha completado (o está finalizando o eliminando).

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que contiene la tarea.

task_id
str
Requerido

Identificador de la tarea que se va a reactivar.

task_reactivate_options
TaskReactivateOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

terminate

Finaliza la tarea especificada.

Cuando se ha terminado la tarea, pasa al estado completado. En el caso de las tareas de varias instancias, la operación finalizar tarea se aplica de forma sincrónica a la tarea principal; Las subtareas se finalizan de forma asincrónica en segundo plano.

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que contiene la tarea.

task_id
str
Requerido

Identificador de la tarea que se va a finalizar.

task_terminate_options
TaskTerminateOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

update

Novedades las propiedades de la tarea especificada.

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que contiene la tarea.

task_id
str
Requerido

Identificador de la tarea que se va a actualizar.

constraints
TaskConstraints
valor predeterminado: None

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.

task_update_options
TaskUpdateOptions
valor predeterminado: None

Parámetros adicionales para la operación

custom_headers
dict
valor predeterminado: None

encabezados que se agregarán a la solicitud

raw
bool
valor predeterminado: False

devuelve la respuesta directa junto con la respuesta deserializada.

operation_config
Requerido

Invalidaciones de configuración de la operación.

Devoluciones

Ninguno o ClientRawResponse si raw=true

Tipo de valor devuelto

None,

Excepciones

Atributos

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>