JobOperations Classe

Operações jobOperations.

Você não deve instanciar diretamente essa classe, mas criar uma instância do Cliente que a criará para você e a anexará como atributo.

Herança

builtins.object

JobOperations

Construtor

JobOperations(client, config, serializer, deserializer)

Parâmetros

client

Obrigatório

Cliente para solicitações de serviço.

config

Obrigatório

Configuração do cliente de serviço.

serializer

Obrigatório

Um serializador de modelo de objeto.

deserializer

Obrigatório

Um desserializador de modelo de objeto.

Variáveis

api_version

A versão da API a ser usada para a solicitação. Valor constante: "2023-05-01.17.0".

Métodos

add	Adiciona um trabalho à conta especificada. O serviço lote dá suporte a duas maneiras de controlar o trabalho feito como parte de um trabalho. Na primeira abordagem, o usuário especifica uma Tarefa do Gerenciador de Trabalhos. O serviço do Lote inicia esta Tarefa quando está pronto para iniciar o Trabalho. A Tarefa gerenciador de trabalho controla todas as outras tarefas executadas neste trabalho usando as APIs de Tarefa. Na segunda abordagem, o usuário controla diretamente a execução de Tarefas em um Trabalho ativo usando as APIs de Tarefa. Observe também: ao nomear Trabalhos, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem ser exibidas nos logs de telemetria acessíveis a engenheiros de Suporte da Microsoft.
delete	Exclui um trabalho. A exclusão de um trabalho também exclui todas as Tarefas que fazem parte desse trabalho e todas as estatísticas de trabalho. Isso também substitui o período de retenção dos dados da Tarefa; ou seja, se o Trabalho contiver Tarefas que ainda são mantidas em Nós de Computação, os serviços do Lote excluirão os diretórios de trabalho dessas Tarefas e todo o conteúdo. Quando uma solicitação Excluir Trabalho é recebida, o serviço lote define o Trabalho como o estado de exclusão. Todas as operações de atualização em um trabalho que está no estado de exclusão falharão com status código 409 (Conflito), com informações adicionais indicando que o trabalho está sendo excluído.
disable	Desabilita o trabalho especificado, impedindo que novas tarefas sejam executadas. O Serviço de Lote move imediatamente o Trabalho para o estado de desabilitação. Em seguida, o Lote usa o parâmetro disableTasks para determinar o que fazer com as Tarefas do Trabalho em execução no momento. O Trabalho permanece no estado de desabilitação até que a operação de desabilitação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; em seguida, o Trabalho é movido para o estado desabilitado. Nenhuma nova Tarefa é iniciada no Trabalho até que ela volte para o estado ativo. Se você tentar desabilitar um Trabalho que esteja em qualquer estado diferente de ativo, desabilitado ou desabilitado, a solicitação falhará com status código 409.
enable	Habilita o trabalho especificado, permitindo que novas Tarefas sejam executadas. Quando você chama essa API, o serviço lote define um Trabalho desabilitado para o estado de habilitação. Depois que essa operação for concluída, o Trabalho passará para o estado ativo e o agendamento de novas Tarefas no Trabalho será retomado. O serviço lote não permite que uma Tarefa permaneça no estado ativo por mais de 180 dias. Portanto, se você habilitar um trabalho que contém tarefas ativas que foram adicionadas há mais de 180 dias, essas Tarefas não serão executadas.
get	Obtém informações sobre o trabalho especificado.
get_task_counts	Obtém as contagens de tarefas para o trabalho especificado. As contagens de tarefas fornecem uma contagem das Tarefas ativas, em execução ou concluídas, e uma contagem de Tarefas que tiveram êxito ou falharam. As tarefas no estado de preparação são contadas como em execução. Observe que os números retornados nem sempre podem estar atualizados. Se você precisar de contagens exatas de tarefas, use uma consulta de lista.
list	Lista todos os trabalhos na conta especificada.
list_from_job_schedule	Lista os Trabalhos que foram criados na Agenda de Trabalho especificada.
list_preparation_and_release_task_status	Lista a status de execução da tarefa preparação do trabalho e liberação de trabalho para o trabalho especificado nos nós de computação em que o trabalho foi executado. Essa API retorna a tarefa preparação do trabalho e a versão do trabalho status em todos os nós de computação que executaram a tarefa Preparação do Trabalho ou Liberação de Trabalho. Isso inclui nós de computação que foram removidos do pool desde então. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação de trabalho ou de liberação de trabalho, o serviço do Lote retornará HTTP status código 409 (Conflito) com um código de erro jobPreparationTaskNotSpecified.
patch	Atualizações as propriedades do Trabalho especificado. Isso substitui apenas as propriedades job especificadas na solicitação. Por exemplo, se o Trabalho tiver restrições e uma solicitação não especificar o elemento de restrições, o Trabalho manterá as restrições existentes.
terminate	Encerra o Trabalho especificado, marcando-o como concluído. Quando uma solicitação Encerrar Trabalho é recebida, o serviço do Lote define o Trabalho como o estado de encerramento. Em seguida, o serviço lote encerra todas as Tarefas em execução associadas ao Trabalho e executa todas as Tarefas de versão de trabalho necessárias. Em seguida, o Trabalho passa para o estado concluído. Se houver tarefas no trabalho no estado ativo, elas permanecerão no estado ativo. Depois que um Trabalho for encerrado, novas Tarefas não poderão ser adicionadas e as Tarefas ativas restantes não serão agendadas.
update	Atualizações as propriedades do Trabalho especificado. Isso substitui totalmente todas as propriedades atualizáveis do Trabalho. Por exemplo, se o Trabalho tiver restrições associadas a ele e se as restrições não forem especificadas com essa solicitação, o serviço do Lote removerá as restrições existentes.

add

Adiciona um trabalho à conta especificada.

O serviço lote dá suporte a duas maneiras de controlar o trabalho feito como parte de um trabalho. Na primeira abordagem, o usuário especifica uma Tarefa do Gerenciador de Trabalhos. O serviço do Lote inicia esta Tarefa quando está pronto para iniciar o Trabalho. A Tarefa gerenciador de trabalho controla todas as outras tarefas executadas neste trabalho usando as APIs de Tarefa. Na segunda abordagem, o usuário controla diretamente a execução de Tarefas em um Trabalho ativo usando as APIs de Tarefa. Observe também: ao nomear Trabalhos, evite incluir informações confidenciais, como nomes de usuário ou nomes de projeto secretos. Essas informações podem ser exibidas nos logs de telemetria acessíveis a engenheiros de Suporte da Microsoft.

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

Parâmetros

job

JobAddParameter

Obrigatório

O trabalho a ser adicionado.

job_add_options

JobAddOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

delete

Exclui um trabalho.

A exclusão de um trabalho também exclui todas as Tarefas que fazem parte desse trabalho e todas as estatísticas de trabalho. Isso também substitui o período de retenção dos dados da Tarefa; ou seja, se o Trabalho contiver Tarefas que ainda são mantidas em Nós de Computação, os serviços do Lote excluirão os diretórios de trabalho dessas Tarefas e todo o conteúdo. Quando uma solicitação Excluir Trabalho é recebida, o serviço lote define o Trabalho como o estado de exclusão. Todas as operações de atualização em um trabalho que está no estado de exclusão falharão com status código 409 (Conflito), com informações adicionais indicando que o trabalho está sendo excluído.

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

Parâmetros

job_id

str

Obrigatório

A ID do trabalho a ser excluído.

job_delete_options

JobDeleteOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

disable

Desabilita o trabalho especificado, impedindo que novas tarefas sejam executadas.

O Serviço de Lote move imediatamente o Trabalho para o estado de desabilitação. Em seguida, o Lote usa o parâmetro disableTasks para determinar o que fazer com as Tarefas do Trabalho em execução no momento. O Trabalho permanece no estado de desabilitação até que a operação de desabilitação seja concluída e todas as Tarefas tenham sido tratadas de acordo com a opção disableTasks; em seguida, o Trabalho é movido para o estado desabilitado. Nenhuma nova Tarefa é iniciada no Trabalho até que ela volte para o estado ativo. Se você tentar desabilitar um Trabalho que esteja em qualquer estado diferente de ativo, desabilitado ou desabilitado, a solicitação falhará com status código 409.

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

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho a ser desabilitada.

disable_tasks

str ou DisableJobOption

Obrigatório

Os valores possíveis incluem: 'requeue', 'terminate', 'wait'

job_disable_options

JobDisableOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

enable

Habilita o trabalho especificado, permitindo que novas Tarefas sejam executadas.

Quando você chama essa API, o serviço lote define um Trabalho desabilitado para o estado de habilitação. Depois que essa operação for concluída, o Trabalho passará para o estado ativo e o agendamento de novas Tarefas no Trabalho será retomado. O serviço lote não permite que uma Tarefa permaneça no estado ativo por mais de 180 dias. Portanto, se você habilitar um trabalho que contém tarefas ativas que foram 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

job_id

str

Obrigatório

A ID do trabalho a ser habilitado.

job_enable_options

JobEnableOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

get

Obtém informações sobre o trabalho especificado.

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

Parâmetros

job_id

str

Obrigatório

A ID do trabalho.

job_get_options

JobGetOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

CloudJob ou ClientRawResponse se raw=true

Tipo de retorno

CloudJob,

ClientRawResponse

Exceções

BatchErrorException

get_task_counts

Obtém as contagens de tarefas para o trabalho especificado.

As contagens de tarefas fornecem uma contagem das Tarefas ativas, em execução ou concluídas, e uma contagem de Tarefas que tiveram êxito ou falharam. As tarefas no estado de preparação são contadas como em execução. Observe que os números retornados nem sempre podem estar atualizados. Se você precisar de contagens exatas de tarefas, use 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_id

str

Obrigatório

A ID do trabalho.

job_get_task_counts_options

JobGetTaskCountsOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

TaskCountsResult ou ClientRawResponse se raw=true

Tipo de retorno

TaskCountsResult,

ClientRawResponse

Exceções

BatchErrorException

list

Lista todos os trabalhos na conta especificada.

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

Parâmetros

job_list_options

JobListOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância do CloudJob

Tipo de retorno

CloudJobPaged[CloudJob]

Exceções

BatchErrorException

list_from_job_schedule

Lista os Trabalhos que foram criados na Agenda de Trabalho 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

Obrigatório

A ID da Agenda de Trabalho da qual você deseja obter uma lista de Trabalhos.

job_list_from_job_schedule_options

JobListFromJobScheduleOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância do CloudJob

Tipo de retorno

CloudJobPaged[CloudJob]

Exceções

BatchErrorException

list_preparation_and_release_task_status

Lista a status de execução da tarefa preparação do trabalho e liberação de trabalho para o trabalho especificado nos nós de computação em que o trabalho foi executado.

Essa API retorna a tarefa preparação do trabalho e a versão do trabalho status em todos os nós de computação que executaram a tarefa Preparação do Trabalho ou Liberação de Trabalho. Isso inclui nós de computação que foram removidos do pool desde então. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação de trabalho ou de liberação de trabalho, o serviço do Lote retornará HTTP status código 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_id

str

Obrigatório

A ID do trabalho.

job_list_preparation_and_release_task_status_options

JobListPreparationAndReleaseTaskStatusOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta ao lado da resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância de JobPreparationAndReleaseTaskExecutionInformation

Tipo de retorno

JobPreparationAndReleaseTaskExecutionInformationPaged[JobPreparationAndReleaseTaskExecutionInformation]

Exceções

BatchErrorException

patch

Atualizações as propriedades do Trabalho especificado.

Isso substitui apenas as propriedades job especificadas na solicitação. Por exemplo, se o Trabalho tiver restrições e uma solicitação não especificar o elemento de restrições, o Trabalho manterá as restrições existentes.

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

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho cujas propriedades você deseja atualizar.

job_patch_parameter

JobPatchParameter

Obrigatório

Os parâmetros da solicitação.

job_patch_options

JobPatchOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

terminate

Encerra o Trabalho especificado, marcando-o como concluído.

Quando uma solicitação Encerrar Trabalho é recebida, o serviço do Lote define o Trabalho como o estado de encerramento. Em seguida, o serviço lote encerra todas as Tarefas em execução associadas ao Trabalho e executa todas as Tarefas de versão de trabalho necessárias. Em seguida, o Trabalho passa para o estado concluído. Se houver tarefas no trabalho no estado ativo, elas permanecerão no estado ativo. Depois que um Trabalho for encerrado, novas Tarefas não poderão ser adicionadas e as 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

job_id

str

Obrigatório

A ID do Trabalho a ser encerrado.

terminate_reason

str

valor padrão: None

job_terminate_options

JobTerminateOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

update

Atualizações as propriedades do Trabalho especificado.

Isso substitui totalmente todas as propriedades atualizáveis do Trabalho. Por exemplo, se o Trabalho tiver restrições associadas a ele e se as restrições não forem especificadas com essa solicitação, o serviço do Lote removerá as restrições existentes.

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

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho cujas propriedades você deseja atualizar.

job_update_parameter

JobUpdateParameter

Obrigatório

Os parâmetros da solicitação.

job_update_options

JobUpdateOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

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