Compartilhar via


TaskOperations Classe

Operações taskOperations.

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
TaskOperations

Construtor

TaskOperations(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 uma Tarefa ao Trabalho especificado.

O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não tiver sido concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço lote e deixada em qualquer estado em que estava naquele momento.

add_collection

Adiciona uma coleção de tarefas ao trabalho especificado.

Observe que cada tarefa deve ter uma ID exclusiva. O serviço lote pode não retornar os resultados de cada tarefa na mesma ordem em que as tarefas foram enviadas nesta solicitação. Se o servidor atingir o tempo limite ou a conexão for fechada durante a solicitação, a solicitação poderá ter sido parcial ou totalmente processada ou não. Nesses casos, o usuário deve emitir novamente a solicitação. Observe que cabe ao usuário lidar corretamente com falhas ao emitir novamente uma solicitação. Por exemplo, você deve usar as mesmas IDs de tarefa durante uma repetição para que, se a operação anterior for bem-sucedida, a repetição não criará tarefas extras inesperadamente. Se a resposta contiver tarefas que não foram adicionadas, um cliente poderá repetir a solicitação. Em uma repetição, é mais eficiente reenviar apenas as tarefas que não foram adicionadas e omitir tarefas que foram adicionadas com êxito na primeira tentativa. O tempo de vida máximo de uma tarefa desde a adição até a conclusão é de 180 dias. Se uma tarefa não tiver sido concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço do Lote e deixada em qualquer estado em que estava naquele momento.

delete

Exclui uma Tarefa do Trabalho especificado.

Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação em que ele foi executado também são excluídos (independentemente do tempo de retenção). Para tarefas de várias instâncias, a operação excluir Tarefa aplica-se de forma síncrona à tarefa primária; Subtarefas e seus arquivos são então excluídos de forma assíncrona em segundo plano.

get

Obtém informações sobre a Tarefa especificada.

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

list

Lista todas as Tarefas associadas ao Trabalho especificado.

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

list_subtasks

Lista todas as subtarefas associadas à Tarefa de várias instâncias especificada.

Se Task não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia.

reactivate

Reativa uma Tarefa, permitindo que ela seja executada novamente mesmo que sua contagem de repetições tenha sido esgotada.

A reativação torna uma Tarefa qualificada para ser repetida novamente até sua contagem máxima de repetições. O estado da Tarefa é alterado para ativo. Como a Tarefa não está mais no estado concluído, qualquer código de saída anterior ou informações de falha não estão mais disponíveis após a reativação. Cada vez que uma Tarefa é reativada, sua contagem de repetições é redefinida para 0. A reativação falhará para Tarefas que não foram concluídas ou que foram concluídas com êxito (com um código de saída de 0). Além disso, ele falhará se o Trabalho tiver sido concluído (ou estiver encerrando ou excluindo).

terminate

Encerra a Tarefa especificada.

Quando a Tarefa foi encerrada, ela passa para o estado concluído. Para tarefas de várias instâncias, a operação encerrar Tarefa aplica-se de forma síncrona à tarefa primária; As subtarefas são então encerradas de forma assíncrona em segundo plano.

update

Atualizações as propriedades da Tarefa especificada.

add

Adiciona uma Tarefa ao Trabalho especificado.

O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não tiver sido concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço lote e deixada em qualquer estado em que estava naquele momento.

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

Parâmetros

job_id
str
Obrigatório

A ID do Trabalho ao qual a Tarefa deve ser adicionada.

task
TaskAddParameter
Obrigatório

A Tarefa a ser adicionada.

task_add_options
TaskAddOptions
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,

Exceções

add_collection

Adiciona uma coleção de tarefas ao trabalho especificado.

Observe que cada tarefa deve ter uma ID exclusiva. O serviço lote pode não retornar os resultados de cada tarefa na mesma ordem em que as tarefas foram enviadas nesta solicitação. Se o servidor atingir o tempo limite ou a conexão for fechada durante a solicitação, a solicitação poderá ter sido parcial ou totalmente processada ou não. Nesses casos, o usuário deve emitir novamente a solicitação. Observe que cabe ao usuário lidar corretamente com falhas ao emitir novamente uma solicitação. Por exemplo, você deve usar as mesmas IDs de tarefa durante uma repetição para que, se a operação anterior for bem-sucedida, a repetição não criará tarefas extras inesperadamente. Se a resposta contiver tarefas que não foram adicionadas, um cliente poderá repetir a solicitação. Em uma repetição, é mais eficiente reenviar apenas as tarefas que não foram adicionadas e omitir tarefas que foram adicionadas com êxito na primeira tentativa. O tempo de vida máximo de uma tarefa desde a adição até a conclusão é de 180 dias. Se uma tarefa não tiver sido concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço do Lote e deixada em qualquer estado em que estava naquele 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
Obrigatório

A ID do trabalho ao qual a coleção de tarefas deve ser adicionada.

value
list of TaskAddParameter
Obrigatório

A coleção de tarefas a serem adicionadas. O tamanho total serializado dessa coleção deve ser menor que 4 MB. Se for maior que 4 MB (por exemplo, se cada tarefa tiver 100 s de arquivos de recurso ou variáveis de ambiente), a solicitação falhará com o código 'RequestBodyTooLarge' e deverá ser repetida novamente com menos tarefas.

task_add_collection_options
TaskAddCollectionOptions
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

threads
int
valor padrão: 0

número de threads a serem usados em paralelo ao adicionar tarefas. Se especificado e maior que 0, iniciará threads adicionais para enviar solicitações e aguardará a conclusão delas. Caso contrário, enviará add_collection solicitações sequencialmente em main thread

Retornos

TaskAddCollectionResult ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

azure.batch.custom.CreateTasksErrorException

delete

Exclui uma Tarefa do Trabalho especificado.

Quando uma Tarefa é excluída, todos os arquivos em seu diretório no Nó de Computação em que ele foi executado também são excluídos (independentemente do tempo de retenção). Para tarefas de várias instâncias, a operação excluir Tarefa aplica-se de forma síncrona à tarefa primária; Subtarefas e seus arquivos são então excluídos de forma assíncrona em segundo plano.

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

Parâmetros

job_id
str
Obrigatório

A ID do Trabalho do qual excluir a Tarefa.

task_id
str
Obrigatório

A ID da Tarefa a ser excluída.

task_delete_options
TaskDeleteOptions
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,

Exceções

get

Obtém informações sobre a Tarefa especificada.

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

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

Parâmetros

job_id
str
Obrigatório

A ID do Trabalho que contém a Tarefa.

task_id
str
Obrigatório

A ID da Tarefa sobre a qual obter informações.

task_get_options
TaskGetOptions
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

CloudTask ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

list

Lista todas as Tarefas associadas ao Trabalho especificado.

Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

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

Parâmetros

job_id
str
Obrigatório

A ID do Trabalho.

task_list_options
TaskListOptions
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

Um iterador como a instância do CloudTask

Tipo de retorno

Exceções

list_subtasks

Lista todas as subtarefas associadas à Tarefa de várias instâncias especificada.

Se Task não for uma Tarefa de várias instâncias, isso retornará uma coleção vazia.

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

Parâmetros

job_id
str
Obrigatório

A ID do Trabalho.

task_id
str
Obrigatório

A ID da Tarefa.

task_list_subtasks_options
TaskListSubtasksOptions
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

CloudTaskListSubtasksResult ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

reactivate

Reativa uma Tarefa, permitindo que ela seja executada novamente mesmo que sua contagem de repetições tenha sido esgotada.

A reativação torna uma Tarefa qualificada para ser repetida novamente até sua contagem máxima de repetições. O estado da Tarefa é alterado para ativo. Como a Tarefa não está mais no estado concluído, qualquer código de saída anterior ou informações de falha não estão mais disponíveis após a reativação. Cada vez que uma Tarefa é reativada, sua contagem de repetições é redefinida para 0. A reativação falhará para Tarefas que não foram concluídas ou que foram concluídas com êxito (com um código de saída de 0). Além disso, ele falhará se o Trabalho tiver sido concluído (ou estiver encerrando ou excluindo).

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

Parâmetros

job_id
str
Obrigatório

A ID do trabalho que contém a Tarefa.

task_id
str
Obrigatório

A ID da Tarefa a ser reativada.

task_reactivate_options
TaskReactivateOptions
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,

Exceções

terminate

Encerra a Tarefa especificada.

Quando a Tarefa foi encerrada, ela passa para o estado concluído. Para tarefas de várias instâncias, a operação encerrar Tarefa aplica-se de forma síncrona à tarefa primária; As subtarefas são então encerradas de forma assíncrona em segundo plano.

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

Parâmetros

job_id
str
Obrigatório

A ID do trabalho que contém a Tarefa.

task_id
str
Obrigatório

A ID da Tarefa a ser encerrada.

task_terminate_options
TaskTerminateOptions
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,

Exceções

update

Atualizações as propriedades da Tarefa especificada.

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

Parâmetros

job_id
str
Obrigatório

A ID do trabalho que contém a Tarefa.

task_id
str
Obrigatório

A ID da Tarefa a ser atualizada.

constraints
TaskConstraints
valor padrão: None

Restrições que se aplicam a esta Tarefa. Se omitido, a Tarefa recebe as restrições padrão. Para tarefas de várias instâncias, atualizar o tempo de retenção aplica-se somente à Tarefa primária e não às subtarefas.

task_update_options
TaskUpdateOptions
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,

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