JobScheduleOperations Clase

Operaciones JobScheduleOperations.

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

JobScheduleOperations

Constructor

JobScheduleOperations(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 programación de trabajo a la cuenta especificada.
delete	Elimina una programación de trabajo de la cuenta especificada. Al eliminar una programación de trabajos, esto también elimina todos los trabajos y tareas de esa programación. Cuando se eliminan las tareas, también se eliminan todos los archivos de sus directorios de trabajo en los nodos de proceso (se omite el período de retención). Las estadísticas de programación de trabajos ya no son accesibles una vez que se elimina la programación de trabajos, aunque todavía se cuentan para las estadísticas de duración de la cuenta.
disable	Deshabilita una programación de trabajo. No se creará ningún nuevo trabajo hasta que se vuelva a habilitar la programación de trabajos.
enable	Habilita una programación de trabajos.
exists	Comprueba que existe la programación de trabajos especificada.
get	Obtiene información sobre la programación de trabajos especificada.
list	Enumera todas las programaciones de trabajo en la cuenta especificada.
patch	Novedades las propiedades de la programación de trabajos especificada. Esto reemplaza solo las propiedades programación de trabajos especificadas en la solicitud. Por ejemplo, si no se especifica la propiedad schedule con esta solicitud, el servicio Batch mantendrá la programación existente. Los cambios en una programación de trabajos solo afectan a los trabajos creados por la programación después de que se haya realizado la actualización; actualmente, los trabajos en ejecución no se ven afectados.
terminate	Finaliza una programación de trabajo.
update	Novedades las propiedades de la programación de trabajos especificada. Esto reemplaza completamente todas las propiedades actualizables de la programación de trabajos. Por ejemplo, si no se especifica la propiedad schedule con esta solicitud, el servicio Batch quitará la programación existente. Los cambios en una programación de trabajos solo afectan a los trabajos creados por la programación después de que se haya realizado la actualización; actualmente, los trabajos en ejecución no se ven afectados.

add

Agrega una programación de trabajo a la cuenta especificada.

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

cloud_job_schedule

JobScheduleAddParameter

Requerido

Programación de trabajos que se va a agregar.

job_schedule_add_options

JobScheduleAddOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

delete

Elimina una programación de trabajo de la cuenta especificada.

Al eliminar una programación de trabajos, esto también elimina todos los trabajos y tareas de esa programación. Cuando se eliminan las tareas, también se eliminan todos los archivos de sus directorios de trabajo en los nodos de proceso (se omite el período de retención). Las estadísticas de programación de trabajos ya no son accesibles una vez que se elimina la programación de trabajos, aunque todavía se cuentan para las estadísticas de duración de la cuenta.

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a eliminar.

job_schedule_delete_options

JobScheduleDeleteOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

disable

Deshabilita una programación de trabajo.

No se creará ningún nuevo trabajo hasta que se vuelva a habilitar la programación de trabajos.

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a deshabilitar.

job_schedule_disable_options

JobScheduleDisableOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

enable

Habilita una programación de trabajos.

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a habilitar.

job_schedule_enable_options

JobScheduleEnableOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

exists

Comprueba que existe la programación de trabajos especificada.

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que desea comprobar.

job_schedule_exists_options

JobScheduleExistsOptions

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

bool o ClientRawResponse si raw=true

Tipo de valor devuelto

bool,

ClientRawResponse

Excepciones

BatchErrorException

get

Obtiene información sobre la programación de trabajos especificada.

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a obtener.

job_schedule_get_options

JobScheduleGetOptions

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

CloudJobSchedule o ClientRawResponse si raw=true

Tipo de valor devuelto

CloudJobSchedule,

ClientRawResponse

Excepciones

BatchErrorException

list

Enumera todas las programaciones de trabajo en la cuenta especificada.

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

Parámetros

job_schedule_list_options

JobScheduleListOptions

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 CloudJobSchedule

Tipo de valor devuelto

CloudJobSchedulePaged[CloudJobSchedule]

Excepciones

BatchErrorException

patch

Novedades las propiedades de la programación de trabajos especificada.

Esto reemplaza solo las propiedades programación de trabajos especificadas en la solicitud. Por ejemplo, si no se especifica la propiedad schedule con esta solicitud, el servicio Batch mantendrá la programación existente. Los cambios en una programación de trabajos solo afectan a los trabajos creados por la programación después de que se haya realizado la actualización; actualmente, los trabajos en ejecución no se ven afectados.

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a actualizar.

job_schedule_patch_parameter

JobSchedulePatchParameter

Requerido

Parámetros de la solicitud.

job_schedule_patch_options

JobSchedulePatchOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

terminate

Finaliza una programación de trabajo.

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a finalizar.

job_schedule_terminate_options

JobScheduleTerminateOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

update

Novedades las propiedades de la programación de trabajos especificada.

Esto reemplaza completamente todas las propiedades actualizables de la programación de trabajos. Por ejemplo, si no se especifica la propiedad schedule con esta solicitud, el servicio Batch quitará la programación existente. Los cambios en una programación de trabajos solo afectan a los trabajos creados por la programación después de que se haya realizado la actualización; actualmente, los trabajos en ejecución no se ven afectados.

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

Parámetros

job_schedule_id

str

Requerido

Identificador de la programación de trabajos que se va a actualizar.

job_schedule_update_parameter

JobScheduleUpdateParameter

Requerido

Parámetros de la solicitud.

job_schedule_update_options

JobScheduleUpdateOptions

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,

ClientRawResponse

Excepciones

BatchErrorException

Atributos

models

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