Compartir a través de


JobOperations Clase

Operaciones jobOperations.

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
JobOperations

Constructor

JobOperations(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 un trabajo a la cuenta especificada.

El servicio Batch admite dos maneras de controlar el trabajo realizado como parte de un trabajo. En el primer enfoque, el usuario especifica una tarea del Administrador de trabajos. El servicio Batch inicia esta tarea cuando está lista para iniciar el trabajo. La tarea Administrador de trabajos controla todas las demás tareas que se ejecutan en este trabajo mediante las API de tareas. En el segundo enfoque, el usuario controla directamente la ejecución de tareas en un trabajo activo mediante las API de tareas. Tenga en cuenta también: al asignar nombres a trabajos, evite incluir información confidencial, como nombres de usuario o nombres de proyecto secretos. Esta información puede aparecer en los registros de telemetría a los que pueden acceder los ingenieros de Soporte técnico de Microsoft.

delete

Elimina un trabajo.

Al eliminar un trabajo también se eliminan todas las tareas que forman parte de ese trabajo y todas las estadísticas del trabajo. Esto también invalida el período de retención para los datos de tarea; es decir, si el trabajo contiene tareas que todavía se conservan en nodos de proceso, los servicios de Batch eliminan los directorios de trabajo de esas tareas y todo su contenido. Cuando se recibe una solicitud eliminar trabajo, el servicio Batch establece el trabajo en el estado de eliminación. Todas las operaciones de actualización de un trabajo que se encuentra en estado de eliminación producirán un error en el código de estado 409 (conflicto), con información adicional que indica que se está eliminando el trabajo.

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.

enable

Habilita el trabajo especificado, lo que permite que se ejecuten nuevas tareas.

Al llamar a esta API, el servicio Batch establece un trabajo deshabilitado en el estado de habilitación. Una vez completada la operación, el trabajo pasa al estado activo y la programación de nuevas tareas en el trabajo se reanuda. El servicio Batch no permite que una tarea permanezca en estado activo durante más de 180 días. Por lo tanto, si habilita un trabajo que contiene tareas activas que se agregaron hace más de 180 días, esas tareas no se ejecutarán.

get

Obtiene información sobre el trabajo especificado.

get_task_counts

Obtiene los recuentos de tareas para el trabajo especificado.

Los recuentos de tareas proporcionan un recuento de las tareas por estado de tarea activo, en ejecución o completado, y un recuento de tareas que se han realizado correctamente o con errores. Las tareas del estado de preparación se cuentan como en ejecución. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de tareas, use una consulta de lista.

list

Enumera todos los trabajos de la cuenta especificada.

list_from_job_schedule

Enumera los trabajos que se han creado en la programación de trabajos especificada.

list_preparation_and_release_task_status

Enumera el estado de ejecución de la tarea de preparación del trabajo y liberación de trabajos para el trabajo especificado en los nodos de proceso en los que se ha ejecutado el trabajo.

Esta API devuelve el estado de la tarea de preparación del trabajo y liberación de trabajos en todos los nodos de proceso que han ejecutado la tarea de preparación del trabajo o liberación de trabajos. Esto incluye nodos de proceso que se han quitado desde entonces del grupo. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409 (conflicto) con un código de error de JobPreparationTaskNotSpecified.

patch

Novedades las propiedades del trabajo especificado.

Esto reemplaza solo las propiedades de trabajo especificadas en la solicitud. Por ejemplo, si el trabajo tiene restricciones y una solicitud no especifica el elemento constraints, el trabajo mantiene las restricciones existentes.

terminate

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.

update

Novedades las propiedades del trabajo especificado.

Esto reemplaza completamente todas las propiedades actualizables del trabajo. Por ejemplo, si el trabajo tiene restricciones asociadas y si no se especifican restricciones con esta solicitud, el servicio Batch quitará las restricciones existentes.

add

Agrega un trabajo a la cuenta especificada.

El servicio Batch admite dos maneras de controlar el trabajo realizado como parte de un trabajo. En el primer enfoque, el usuario especifica una tarea del Administrador de trabajos. El servicio Batch inicia esta tarea cuando está lista para iniciar el trabajo. La tarea Administrador de trabajos controla todas las demás tareas que se ejecutan en este trabajo mediante las API de tareas. En el segundo enfoque, el usuario controla directamente la ejecución de tareas en un trabajo activo mediante las API de tareas. Tenga en cuenta también: al asignar nombres a trabajos, evite incluir información confidencial, como nombres de usuario o nombres de proyecto secretos. Esta información puede aparecer en los registros de telemetría a los que pueden acceder los ingenieros de Soporte técnico de Microsoft.

add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job
JobAddParameter
Requerido

El trabajo que se va a agregar.

job_add_options
JobAddOptions
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

delete

Elimina un trabajo.

Al eliminar un trabajo también se eliminan todas las tareas que forman parte de ese trabajo y todas las estadísticas del trabajo. Esto también invalida el período de retención para los datos de tarea; es decir, si el trabajo contiene tareas que todavía se conservan en nodos de proceso, los servicios de Batch eliminan los directorios de trabajo de esas tareas y todo su contenido. Cuando se recibe una solicitud eliminar trabajo, el servicio Batch establece el trabajo en el estado de eliminación. Todas las operaciones de actualización de un trabajo que se encuentra en estado de eliminación producirán un error en el código de estado 409 (conflicto), con información adicional que indica que se está eliminando el trabajo.

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

Parámetros

job_id
str
Requerido

Identificador del trabajo que se va a eliminar.

job_delete_options
JobDeleteOptions
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

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.

disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que se va a deshabilitar.

disable_tasks
str o DisableJobOption
Requerido

Entre los valores posibles se incluyen: "requeue", "terminate", "wait"

job_disable_options
JobDisableOptions
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

enable

Habilita el trabajo especificado, lo que permite que se ejecuten nuevas tareas.

Al llamar a esta API, el servicio Batch establece un trabajo deshabilitado en el estado de habilitación. Una vez completada la operación, el trabajo pasa al estado activo y la programación de nuevas tareas en el trabajo se reanuda. El servicio Batch no permite que una tarea permanezca en estado activo durante más de 180 días. Por lo tanto, si habilita un trabajo que contiene tareas activas que se agregaron hace más de 180 días, esas tareas no se ejecutarán.

enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que se va a habilitar.

job_enable_options
JobEnableOptions
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 el trabajo especificado.

get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo.

job_get_options
JobGetOptions
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

CloudJob o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

get_task_counts

Obtiene los recuentos de tareas para el trabajo especificado.

Los recuentos de tareas proporcionan un recuento de las tareas por estado de tarea activo, en ejecución o completado, y un recuento de tareas que se han realizado correctamente o con errores. Las tareas del estado de preparación se cuentan como en ejecución. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de tareas, use una consulta de lista.

get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo.

job_get_task_counts_options
JobGetTaskCountsOptions
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

TaskCountsResult o ClientRawResponse si raw=true

Tipo de valor devuelto

Excepciones

list

Enumera todos los trabajos de la cuenta especificada.

list(job_list_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_list_options
JobListOptions
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 CloudJob

Tipo de valor devuelto

Excepciones

list_from_job_schedule

Enumera los trabajos que se han creado en la programación de trabajos especificada.

list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id
str
Requerido

Identificador de la programación de trabajos desde la que desea obtener una lista de trabajos.

job_list_from_job_schedule_options
JobListFromJobScheduleOptions
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 CloudJob

Tipo de valor devuelto

Excepciones

list_preparation_and_release_task_status

Enumera el estado de ejecución de la tarea de preparación del trabajo y liberación de trabajos para el trabajo especificado en los nodos de proceso en los que se ha ejecutado el trabajo.

Esta API devuelve el estado de la tarea de preparación del trabajo y liberación de trabajos en todos los nodos de proceso que han ejecutado la tarea de preparación del trabajo o liberación de trabajos. Esto incluye nodos de proceso que se han quitado desde entonces del grupo. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409 (conflicto) con un código de error de JobPreparationTaskNotSpecified.

list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo.

job_list_preparation_and_release_task_status_options
JobListPreparationAndReleaseTaskStatusOptions
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 JobPreparationAndReleaseTaskExecutionInformation

Tipo de valor devuelto

Excepciones

patch

Novedades las propiedades del trabajo especificado.

Esto reemplaza solo las propiedades de trabajo especificadas en la solicitud. Por ejemplo, si el trabajo tiene restricciones y una solicitud no especifica el elemento constraints, el trabajo mantiene las restricciones existentes.

patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo cuyas propiedades desea actualizar.

job_patch_parameter
JobPatchParameter
Requerido

Parámetros de la solicitud.

job_patch_options
JobPatchOptions
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 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.

terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo que se va a finalizar.

terminate_reason
str
valor predeterminado: None
job_terminate_options
JobTerminateOptions
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 del trabajo especificado.

Esto reemplaza completamente todas las propiedades actualizables del trabajo. Por ejemplo, si el trabajo tiene restricciones asociadas y si no se especifican restricciones con esta solicitud, el servicio Batch quitará las restricciones existentes.

update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_id
str
Requerido

Identificador del trabajo cuyas propiedades desea actualizar.

job_update_parameter
JobUpdateParameter
Requerido

Parámetros de la solicitud.

job_update_options
JobUpdateOptions
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'>