JobOperations Classe
Operações jobOperations.
Não deve instanciar diretamente esta classe, mas criar uma instância de Cliente que irá criá-la e anexá-la como atributo.
- Herança
-
builtins.objectJobOperations
Construtor
JobOperations(client, config, serializer, deserializer)Parâmetros
- client
Cliente para pedidos de serviço.
- config
Configuração do cliente de serviço.
- serializer
Um serializador de modelo de objeto.
- deserializer
Um desserializador de modelo de objeto.
Variáveis
- api_version
A versão da API a utilizar para o pedido. Valor constante: "2023-05-01.17.0".
Métodos
| add |
Adiciona uma Tarefa à Conta especificada. O serviço Batch suporta duas formas de controlar o trabalho realizado como parte de uma Tarefa. Na primeira abordagem, o utilizador especifica uma Tarefa do Gestor de Tarefas. O serviço Batch inicia esta Tarefa quando estiver pronto para iniciar a Tarefa. A Tarefa do Gestor de Tarefas controla todas as outras Tarefas que são executadas nesta Tarefa através das APIs de Tarefa. Na segunda abordagem, o utilizador controla diretamente a execução de Tarefas numa Tarefa ativa, utilizando as APIs de Tarefa. Nota: ao atribuir nomes a Tarefas, evite incluir informações confidenciais, como nomes de utilizadores ou nomes de projetos secretos. Estas informações podem aparecer em registos de telemetria acessíveis a engenheiros Suporte da Microsoft. |
| delete |
Elimina uma Tarefa. Eliminar uma Tarefa também elimina todas as Tarefas que fazem parte desse Trabalho e todas as estatísticas de tarefas. Isto também substitui o período de retenção dos dados da tarefa; ou seja, se a Tarefa contiver Tarefas que ainda são mantidas em Nós de Computação, os serviços do Batch eliminam os diretórios de trabalho dessas Tarefas e todos os respetivos conteúdos. Quando é recebido um pedido Eliminar Tarefa, o serviço Batch define a Tarefa para o estado de eliminação. Todas as operações de atualização numa Tarefa que esteja no estado de eliminação falharão com o código de estado 409 (Conflito), com informações adicionais que indicam que a Tarefa está a ser eliminada. |
| disable |
Desativa a Tarefa especificada, impedindo a execução de novas Tarefas. O Serviço Batch move imediatamente a Tarefa para o estado de desativação. Em seguida, o Batch utiliza o parâmetro disableTasks para determinar o que fazer com as Tarefas atualmente em execução da Tarefa. A Tarefa permanece no estado de desativação até que a operação de desativação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; em seguida, a Tarefa muda para o estado desativado. Não são iniciadas novas Tarefas na Tarefa até que volte ao estado ativo. Se tentar desativar uma Tarefa que esteja em qualquer estado que não esteja ativo, desativado ou desativado, o pedido falha com o código de estado 409. |
| enable |
Ativa a Tarefa especificada, permitindo a execução de novas Tarefas. Quando chama esta API, o serviço Batch define uma Tarefa desativada para o estado de ativação. Após a conclusão desta operação, a Tarefa muda para o estado ativo e o agendamento de novas Tarefas no âmbito da Tarefa é retomado. O serviço Batch não permite que uma Tarefa permaneça no estado ativo durante mais de 180 dias. Por conseguinte, se ativar uma Tarefa com Tarefas ativas adicionadas há mais de 180 dias, essas Tarefas não serão executadas. |
| get |
Obtém informações sobre a Tarefa especificada. |
| get_task_counts |
Obtém as Contagens de tarefas para a Tarefa especificada. As contagens de tarefas fornecem uma contagem das Tarefas por estado de tarefa ativa, em execução ou concluída, e uma contagem de Tarefas que foram bem-sucedidas ou falharam. As tarefas no estado de preparação são contadas como em execução. Tenha em atenção que os números devolvidos podem nem sempre estar atualizados. Se precisar de contagens de tarefas exatas, utilize uma consulta de lista. |
| list |
Lista todas as Tarefas na Conta especificada. |
| list_from_job_schedule |
Lista as Tarefas que foram criadas ao abrigo da Agenda de Tarefas especificada. |
| list_preparation_and_release_task_status |
Lista o estado de execução da Tarefa de Preparação de Trabalhos e da Tarefa de Libertação de Tarefas para a Tarefa especificada nos Nós de Computação onde a Tarefa foi executada. Esta API devolve o estado de Preparação da Tarefa de Preparação de Tarefas e De Lançamento de Tarefas em todos os Nós de Computação que executaram a Tarefa de Preparação de Tarefas ou a Tarefa de Lançamento de Tarefas. Isto inclui Nós de Computação que foram removidos do Conjunto. Se esta API for invocada numa Tarefa que não tenha nenhuma Tarefa de Preparação de Tarefas ou de Versão de Tarefas, o serviço Batch devolve o código de estado HTTP 409 (Conflito) com um código de erro jobPreparationTaskNotSpecified. |
| patch |
Atualizações as propriedades da Tarefa especificada. Esta ação substitui apenas as propriedades da tarefa especificadas no pedido. Por exemplo, se a Tarefa tiver restrições e um pedido não especificar o elemento de restrições, a Tarefa mantém as restrições existentes. |
| terminate |
Termina a Tarefa especificada, marcando-a como concluída. Quando é recebido um pedido de Terminar Tarefa, o serviço Batch define a Tarefa para o estado de terminação. Em seguida, o serviço Batch termina todas as Tarefas em execução associadas à Tarefa e executa todas as Tarefas de lançamento de tarefas necessárias. Em seguida, a Tarefa muda para o estado concluído. Se existirem Tarefas na Tarefa no estado ativo, estas permanecerão no estado ativo. Assim que uma Tarefa for terminada, não é possível adicionar novas Tarefas e quaisquer Tarefas ativas restantes não serão agendadas. |
| update |
Atualizações as propriedades da Tarefa especificada. Esta ação substitui totalmente todas as propriedades atualizáveis da Tarefa. Por exemplo, se a Tarefa tiver restrições associadas e se as restrições não forem especificadas com este pedido, o serviço Batch removerá as restrições existentes. |
add
Adiciona uma Tarefa à Conta especificada.
O serviço Batch suporta duas formas de controlar o trabalho realizado como parte de uma Tarefa. Na primeira abordagem, o utilizador especifica uma Tarefa do Gestor de Tarefas. O serviço Batch inicia esta Tarefa quando estiver pronto para iniciar a Tarefa. A Tarefa do Gestor de Tarefas controla todas as outras Tarefas que são executadas nesta Tarefa através das APIs de Tarefa. Na segunda abordagem, o utilizador controla diretamente a execução de Tarefas numa Tarefa ativa, utilizando as APIs de Tarefa. Nota: ao atribuir nomes a Tarefas, evite incluir informações confidenciais, como nomes de utilizadores ou nomes de projetos secretos. Estas informações podem aparecer em registos de telemetria acessíveis a engenheiros Suporte da Microsoft.
add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
delete
Elimina uma Tarefa.
Eliminar uma Tarefa também elimina todas as Tarefas que fazem parte desse Trabalho e todas as estatísticas de tarefas. Isto também substitui o período de retenção dos dados da tarefa; ou seja, se a Tarefa contiver Tarefas que ainda são mantidas em Nós de Computação, os serviços do Batch eliminam os diretórios de trabalho dessas Tarefas e todos os respetivos conteúdos. Quando é recebido um pedido Eliminar Tarefa, o serviço Batch define a Tarefa para o estado de eliminação. Todas as operações de atualização numa Tarefa que esteja no estado de eliminação falharão com o código de estado 409 (Conflito), com informações adicionais que indicam que a Tarefa está a ser eliminada.
delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
disable
Desativa a Tarefa especificada, impedindo a execução de novas Tarefas.
O Serviço Batch move imediatamente a Tarefa para o estado de desativação. Em seguida, o Batch utiliza o parâmetro disableTasks para determinar o que fazer com as Tarefas atualmente em execução da Tarefa. A Tarefa permanece no estado de desativação até que a operação de desativação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; em seguida, a Tarefa muda para o estado desativado. Não são iniciadas novas Tarefas na Tarefa até que volte ao estado ativo. Se tentar desativar uma Tarefa que esteja em qualquer estado que não esteja ativo, desativado ou desativado, o pedido falha com o código de estado 409.
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- disable_tasks
- str ou DisableJobOption
Os valores possíveis incluem: "requeue", "terminate", "wait"
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
enable
Ativa a Tarefa especificada, permitindo a execução de novas Tarefas.
Quando chama esta API, o serviço Batch define uma Tarefa desativada para o estado de ativação. Após a conclusão desta operação, a Tarefa muda para o estado ativo e o agendamento de novas Tarefas no âmbito da Tarefa é retomado. O serviço Batch não permite que uma Tarefa permaneça no estado ativo durante mais de 180 dias. Por conseguinte, se ativar uma Tarefa com Tarefas ativas adicionadas há mais de 180 dias, essas Tarefas não serão executadas.
enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
get
Obtém informações sobre a Tarefa especificada.
get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
CloudJob ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
get_task_counts
Obtém as Contagens de tarefas para a Tarefa especificada.
As contagens de tarefas fornecem uma contagem das Tarefas por estado de tarefa ativa, em execução ou concluída, e uma contagem de Tarefas que foram bem-sucedidas ou falharam. As tarefas no estado de preparação são contadas como em execução. Tenha em atenção que os números devolvidos podem nem sempre estar atualizados. Se precisar de contagens de tarefas exatas, utilize uma consulta de lista.
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- job_get_task_counts_options
- JobGetTaskCountsOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
TaskCountsResult ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
list
Lista todas as Tarefas na Conta especificada.
list(job_list_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Um iterador como a instância do CloudJob
Tipo de retorno
Exceções
list_from_job_schedule
Lista as Tarefas que foram criadas ao abrigo da Agenda de Tarefas 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
O ID da Agenda de Tarefas a partir da qual pretende obter uma lista de Tarefas.
- job_list_from_job_schedule_options
- JobListFromJobScheduleOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Um iterador como a instância do CloudJob
Tipo de retorno
Exceções
list_preparation_and_release_task_status
Lista o estado de execução da Tarefa de Preparação de Trabalhos e da Tarefa de Libertação de Tarefas para a Tarefa especificada nos Nós de Computação onde a Tarefa foi executada.
Esta API devolve o estado de Preparação da Tarefa de Preparação de Tarefas e De Lançamento de Tarefas em todos os Nós de Computação que executaram a Tarefa de Preparação de Tarefas ou a Tarefa de Lançamento de Tarefas. Isto inclui Nós de Computação que foram removidos do Conjunto. Se esta API for invocada numa Tarefa que não tenha nenhuma Tarefa de Preparação de Tarefas ou de Versão de Tarefas, o serviço Batch devolve o código de estado HTTP 409 (Conflito) com um código de erro 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_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Um iterador como a instância de JobPreparationAndReleaseTaskExecutionInformation
Tipo de retorno
Exceções
patch
Atualizações as propriedades da Tarefa especificada.
Esta ação substitui apenas as propriedades da tarefa especificadas no pedido. Por exemplo, se a Tarefa tiver restrições e um pedido não especificar o elemento de restrições, a Tarefa mantém as restrições existentes.
patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
terminate
Termina a Tarefa especificada, marcando-a como concluída.
Quando é recebido um pedido de Terminar Tarefa, o serviço Batch define a Tarefa para o estado de terminação. Em seguida, o serviço Batch termina todas as Tarefas em execução associadas à Tarefa e executa todas as Tarefas de lançamento de tarefas necessárias. Em seguida, a Tarefa muda para o estado concluído. Se existirem Tarefas na Tarefa no estado ativo, estas permanecerão no estado ativo. Assim que uma Tarefa for terminada, não é possível adicionar novas Tarefas e quaisquer Tarefas ativas restantes não serão agendadas.
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- terminate_reason
- str
- job_terminate_options
- JobTerminateOptions
Parâmetros adicionais para a operação
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
update
Atualizações as propriedades da Tarefa especificada.
Esta ação substitui totalmente todas as propriedades atualizáveis da Tarefa. Por exemplo, se a Tarefa tiver restrições associadas e se as restrições não forem especificadas com este pedido, o serviço Batch removerá as restrições existentes.
update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)Parâmetros
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
Nenhum ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
Atributos
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python