TaskOperations Classe

Operações taskOperations.

Não deve instanciar diretamente esta classe, mas criar uma instância de Cliente que irá criá-la por si e anexá-la como atributo.

Herança

builtins.object

TaskOperations

Construtor

TaskOperations(client, config, serializer, deserializer)

Parâmetros

client

Necessário

Cliente para pedidos de serviço.

config

Necessário

Configuração do cliente de serviço.

serializer

Necessário

Um serializador de modelo de objeto.

deserializer

Necessário

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 à Tarefa especificada. A duração máxima de uma Tarefa de adição à conclusão é de 180 dias. Se uma Tarefa não tiver sido concluída no prazo de 180 dias após ser adicionada, será terminada pelo serviço Batch e deixada em qualquer estado em que estava nessa altura.
add_collection	Adiciona uma coleção de tarefas à tarefa especificada. Tenha em atenção que cada tarefa tem de ter um ID exclusivo. O serviço Batch pode não devolver os resultados de cada tarefa pela mesma ordem em que as tarefas foram submetidas neste pedido. Se o servidor exceder o limite de tempo ou a ligação for fechada durante o pedido, o pedido poderá ter sido parcial ou totalmente processado ou não ter sido de todo. Nesses casos, o utilizador deve emitir novamente o pedido. Tenha em atenção que cabe ao utilizador processar corretamente as falhas ao emitir novamente um pedido. Por exemplo, deve utilizar os mesmos IDs de tarefa durante uma repetição para que, se a operação anterior tiver êxito, a repetição não crie tarefas adicionais inesperadamente. Se a resposta contiver tarefas que não foram adicionadas, um cliente pode repetir o pedido. Numa repetição, é mais eficiente submeter novamente apenas as tarefas que não foram adicionadas e omitir tarefas que foram adicionadas com êxito na primeira tentativa. A duração máxima de uma tarefa desde a adição à conclusão é de 180 dias. Se uma tarefa não tiver sido concluída no prazo de 180 dias após a sua adição, será terminada pelo serviço Batch e deixada em qualquer estado em que estava nessa altura.
delete	Elimina uma Tarefa da Tarefa especificada. Quando uma Tarefa é eliminada, todos os ficheiros no respetivo diretório no Nó de Computação onde foi executada também são eliminados (independentemente do tempo de retenção). Para Tarefas de várias instâncias, a operação eliminar Tarefa aplica-se de forma síncrona à tarefa primária; As subtarefas e os respetivos ficheiros são eliminados 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. Utilize a API de subtarefas de lista para obter informações sobre subtarefas.
list	Lista todas as Tarefas associadas à Tarefa especificada. Para Tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Utilize a API de subtarefas de lista para obter informações sobre subtarefas.
list_subtasks	Lista todas as subtarefas que estão associadas à Tarefa de várias instâncias especificada. Se a Tarefa não for uma Tarefa de várias instâncias, esta ação devolve uma coleção vazia.
reactivate	Reativa uma Tarefa, permitindo que seja executada novamente, mesmo que a contagem de repetições tenha sido esgotada. A reativação torna uma Tarefa elegível para ser repetida novamente até à contagem máxima de repetições. O estado da Tarefa é alterado para ativo. Uma vez que a Tarefa já não está no estado concluído, quaisquer informações anteriores sobre o código de saída ou falha já não estão disponíveis após a reativação. Sempre que uma Tarefa é reativada, a contagem de repetições é reposta para 0. A reativação falhará para Tarefas que não estejam concluídas ou que tenham sido concluídas com êxito (com um código de saída de 0). Além disso, falhará se a Tarefa tiver sido concluída (ou estiver a terminar ou a eliminar).
terminate	Termina a Tarefa especificada. Quando a Tarefa tiver sido terminada, é movida para o estado concluído. Para Tarefas de várias instâncias, a operação terminar Tarefa aplica-se de forma síncrona à tarefa primária; As subtarefas são terminadas de forma assíncrona em segundo plano.
update	Atualizações as propriedades da Tarefa especificada.

add

Adiciona uma Tarefa à Tarefa especificada.

A duração máxima de uma Tarefa de adição à conclusão é de 180 dias. Se uma Tarefa não tiver sido concluída no prazo de 180 dias após ser adicionada, será terminada pelo serviço Batch e deixada em qualquer estado em que estava nessa altura.

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

Parâmetros

job_id

str

Necessário

O ID da Tarefa à qual a Tarefa deve ser adicionada.

task

TaskAddParameter

Necessário

A Tarefa a adicionar.

task_add_options

TaskAddOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

add_collection

Adiciona uma coleção de tarefas à tarefa especificada.

Tenha em atenção que cada tarefa tem de ter um ID exclusivo. O serviço Batch pode não devolver os resultados de cada tarefa pela mesma ordem em que as tarefas foram submetidas neste pedido. Se o servidor exceder o limite de tempo ou a ligação for fechada durante o pedido, o pedido poderá ter sido parcial ou totalmente processado ou não ter sido de todo. Nesses casos, o utilizador deve emitir novamente o pedido. Tenha em atenção que cabe ao utilizador processar corretamente as falhas ao emitir novamente um pedido. Por exemplo, deve utilizar os mesmos IDs de tarefa durante uma repetição para que, se a operação anterior tiver êxito, a repetição não crie tarefas adicionais inesperadamente. Se a resposta contiver tarefas que não foram adicionadas, um cliente pode repetir o pedido. Numa repetição, é mais eficiente submeter novamente apenas as tarefas que não foram adicionadas e omitir tarefas que foram adicionadas com êxito na primeira tentativa. A duração máxima de uma tarefa desde a adição à conclusão é de 180 dias. Se uma tarefa não tiver sido concluída no prazo de 180 dias após a sua adição, será terminada pelo serviço Batch e deixada em qualquer estado em que estava nessa altura.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Parâmetros

job_id

str

Necessário

O ID da tarefa à qual a coleção de tarefas deve ser adicionada.

value

list of TaskAddParameter

Necessário

A coleção de tarefas a adicionar. O tamanho serializado total desta coleção tem de ser inferior a 4 MB. Se for superior a 4 MB (por exemplo, se cada tarefa tiver 100 de ficheiros de recursos ou variáveis de ambiente), o pedido falhará com o código "RequestBodyTooLarge" e deverá ser repetido novamente com menos tarefas.

task_add_collection_options

TaskAddCollectionOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

threads

int

valor predefinido: 0

número de threads a utilizar em paralelo ao adicionar tarefas. Se especificado e superior a 0, iniciará threads adicionais para submeter pedidos e aguardará que sejam concluídos. Caso contrário, submeterá add_collection pedidos sequencialmente no thread principal

Devoluções

TaskAddCollectionResult ou ClientRawResponse se raw=true

Tipo de retorno

TaskAddCollectionResult,

ClientRawResponse

Exceções

azure.batch.custom.CreateTasksErrorException

delete

Elimina uma Tarefa da Tarefa especificada.

Quando uma Tarefa é eliminada, todos os ficheiros no respetivo diretório no Nó de Computação onde foi executada também são eliminados (independentemente do tempo de retenção). Para Tarefas de várias instâncias, a operação eliminar Tarefa aplica-se de forma síncrona à tarefa primária; As subtarefas e os respetivos ficheiros são eliminados 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

Necessário

O ID da Tarefa a partir da qual pretende eliminar a Tarefa.

task_id

str

Necessário

O ID da Tarefa a eliminar.

task_delete_options

TaskDeleteOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

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. Utilize a API de subtarefas de lista para obter 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

Necessário

O ID da Tarefa que contém a Tarefa.

task_id

str

Necessário

O ID da Tarefa para obter informações sobre.

task_get_options

TaskGetOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

CloudTask ou ClientRawResponse se raw=true

Tipo de retorno

CloudTask,

ClientRawResponse

Exceções

BatchErrorException

list

Lista todas as Tarefas associadas à Tarefa especificada.

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

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

Parâmetros

job_id

str

Necessário

O ID da Tarefa.

task_list_options

TaskListOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Um iterador como a instância do CloudTask

Tipo de retorno

CloudTaskPaged[CloudTask]

Exceções

BatchErrorException

list_subtasks

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

Se a Tarefa não for uma Tarefa de várias instâncias, esta ação devolve 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

Necessário

O ID da Tarefa.

task_id

str

Necessário

O ID da Tarefa.

task_list_subtasks_options

TaskListSubtasksOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

CloudTaskListSubtasksResult ou ClientRawResponse se raw=true

Tipo de retorno

CloudTaskListSubtasksResult,

ClientRawResponse

Exceções

BatchErrorException

reactivate

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

A reativação torna uma Tarefa elegível para ser repetida novamente até à contagem máxima de repetições. O estado da Tarefa é alterado para ativo. Uma vez que a Tarefa já não está no estado concluído, quaisquer informações anteriores sobre o código de saída ou falha já não estão disponíveis após a reativação. Sempre que uma Tarefa é reativada, a contagem de repetições é reposta para 0. A reativação falhará para Tarefas que não estejam concluídas ou que tenham sido concluídas com êxito (com um código de saída de 0). Além disso, falhará se a Tarefa tiver sido concluída (ou estiver a terminar ou a eliminar).

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

Parâmetros

job_id

str

Necessário

O ID da Tarefa que contém a Tarefa.

task_id

str

Necessário

O ID da Tarefa a reativar.

task_reactivate_options

TaskReactivateOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

terminate

Termina a Tarefa especificada.

Quando a Tarefa tiver sido terminada, é movida para o estado concluído. Para Tarefas de várias instâncias, a operação terminar Tarefa aplica-se de forma síncrona à tarefa primária; As subtarefas são terminadas 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

Necessário

O ID da Tarefa que contém a Tarefa.

task_id

str

Necessário

O ID da Tarefa a terminar.

task_terminate_options

TaskTerminateOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

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

Necessário

O ID da Tarefa que contém a Tarefa.

task_id

str

Necessário

O ID da Tarefa a atualizar.

constraints

TaskConstraints

valor predefinido: None

Restrições que se aplicam a esta Tarefa. Se for omitido, as restrições predefinidas são atribuídas à Tarefa. Para tarefas de várias instâncias, atualizar o tempo de retenção aplica-se apenas à Tarefa principal e não a subtarefas.

task_update_options

TaskUpdateOptions

valor predefinido: None

Parâmetros adicionais para a operação

custom_headers

dict

valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw

bool

valor predefinido: False

devolve a resposta direta juntamente com a resposta serializada

operation_config

Necessário

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

Devoluções

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