Compartilhar via


JobAddParameter Classe

Um trabalho Lote do Azure a ser adicionado.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.

Herança
JobAddParameter

Construtor

JobAddParameter(*, id: str, pool_info, display_name: str = None, priority: int = None, max_parallel_tasks: int = -1, allow_task_preemption: bool = None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies: bool = None, network_configuration=None, **kwargs)

Parâmetros

id
str
Obrigatório

Obrigatórios. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. A ID não diferencia maiúsculas de minúsculas e diferencia maiúsculas de minúsculas (ou seja, você pode não ter duas IDs em uma Conta que diferem apenas por caso).

display_name
str
Obrigatório

O nome de exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.

priority
int
Obrigatório

A prioridade do Trabalho. Valores de prioridade podem variar de -1000 a 1000,-1000 sendo a prioridade mais baixa e 1000 a prioridade mais alta. O valor padrão é 0.

max_parallel_tasks
int
Obrigatório

O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. O valor de maxParallelTasks deve ser -1 ou maior que 0, se especificado. Se não for especificado, o valor padrão será -1, o que significa que não há limite para o número de tarefas que podem ser executadas de uma só vez. Você pode atualizar maxParallelTasks de um trabalho depois de ele ter sido criado usando a API de trabalho de atualização. Valor padrão: -1 .

allow_task_preemption
bool
Obrigatório

Se as Tarefas neste trabalho podem ser preempcionadas por outros trabalhos de alta prioridade. Se o valor for definido como True, outros trabalhos de alta prioridade enviados ao sistema terão precedência e poderão reencair tarefas desse trabalho. Você pode atualizar allowTaskPreemption de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.

constraints
JobConstraints
Obrigatório

As restrições de execução para o Trabalho.

job_manager_task
JobManagerTask
Obrigatório

Detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando o Trabalho for iniciado. Se o Trabalho não especificar uma Tarefa do Gerenciador de Trabalhos, o usuário deverá adicionar explicitamente Tarefas ao Trabalho. Se o Trabalho especificar uma Tarefa do Gerenciador de Trabalhos, o serviço do Lote criará a Tarefa Gerenciador de Trabalhos quando o Trabalho for criado e tentará agendar a Tarefa do Gerenciador de Trabalhos antes de agendar outras Tarefas no Trabalho. A finalidade típica da Tarefa do Gerenciador de Trabalhos é controlar e/ou monitorar a execução do trabalho, por exemplo, decidindo quais tarefas adicionais executar, determinando quando o trabalho está concluído etc. (No entanto, uma tarefa do Gerenciador de Trabalhos não está restrita a essas atividades – é uma Tarefa completa no sistema e executa todas as ações necessárias para o Trabalho.) Por exemplo, uma Tarefa do Gerenciador de Trabalhos pode baixar um arquivo especificado como um parâmetro, analisar o conteúdo desse arquivo e enviar tarefas adicionais com base nesses conteúdos.

job_preparation_task
JobPreparationTask
Obrigatório

A Tarefa de Preparação do Trabalho. Se um trabalho tiver uma tarefa de preparação de trabalho, o serviço do Lote executará a Tarefa de Preparação de Trabalho em um Nó antes de iniciar qualquer Tarefa desse trabalho nesse nó de computação.

job_release_task
JobReleaseTask
Obrigatório

A tarefa De liberação do trabalho. Uma Tarefa de Liberação de Trabalho não pode ser especificada sem especificar também uma Tarefa de Preparação de Trabalho para o Trabalho. O serviço lote executa a Tarefa de Liberação de Trabalho nos nós que executaram a Tarefa de Preparação de Trabalho. A principal finalidade da Tarefa de Liberação do Trabalho é desfazer as alterações nos Nós de Computação feitas pela Tarefa de Preparação do Trabalho. As atividades de exemplo incluem a exclusão de arquivos locais ou o desligamento de serviços que foram iniciados como parte da preparação do trabalho.

common_environment_settings
list[EnvironmentSetting]
Obrigatório

Tarefas individuais podem substituir uma configuração de ambiente especificada aqui especificando o mesmo nome de configuração com um valor diferente.

pool_info
PoolInformation
Obrigatório

Obrigatórios. O pool no qual o serviço do Lote executa as Tarefas do Trabalho.

on_all_tasks_complete
str ou OnAllTasksComplete
Obrigatório

A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído. Observe que, se um Trabalho não contiver Tarefas, todas as Tarefas serão consideradas concluídas. Portanto, essa opção é mais usada com uma tarefa do Gerenciador de Trabalhos; se você quiser usar a terminação automática de trabalho sem um Gerenciador de Trabalhos, inicialmente deverá definir onAllTasksComplete como noaction e atualizar as propriedades de Trabalho para definir onAllTasksComplete para terminatejob depois de terminar de adicionar Tarefas. O padrão é noaction. Os valores possíveis incluem: 'noAction', 'terminateJob'

on_task_failure
str ou OnTaskFailure
Obrigatório

A ação que o serviço do Lote deve executar quando qualquer Tarefa no Trabalho falhar. Uma Tarefa será considerada com falha se tiver um failureInfo. Um failureInfo será definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de repetições ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download de arquivo de recurso. O padrão é noaction. Os valores possíveis incluem: 'noAction', 'performExitOptionsJobAction'

metadata
list[MetadataItem]
Obrigatório

O serviço lote não atribui nenhum significado aos metadados; é exclusivamente para o uso do código do usuário.

uses_task_dependencies
bool
Obrigatório

Se tarefas no trabalho podem definir dependências entre si. O padrão é falso.

network_configuration
JobNetworkConfiguration
Obrigatório

A configuração de rede para o Trabalho.

Métodos

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

enable_additional_properties_sending
from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parâmetros

key_transformer
<xref:function>

Uma função de transformador de chave.

keep_readonly
valor padrão: True

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

data
str
Obrigatório

Um str usando a estrutura RestAPI. JSON por padrão.

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parâmetros

data
dict
Obrigatório

Um ditado usando a estrutura RestAPI

content_type
str
valor padrão: None

JSON por padrão, defina application/xml se XML.

key_extractors
valor padrão: None

Retornos

Uma instância desse modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly
bool
valor padrão: False

Se você quiser serializar os atributos somente leitura

Retornos

Um objeto compatível com JSON de dict

Tipo de retorno

validate

Valide esse modelo recursivamente e retorne uma lista de ValidationError.

validate()

Retornos

Uma lista de erros de validação

Tipo de retorno