Tasks - Create Task

A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Cabeçalhos

• DataServiceId: string
• ETag: string
• Last-Modified: string
• client-request-id: string
• request-id: string

BatchError

Uma resposta de erro inesperada.

BatchAccessScope[]

Os recursos do lote aos quais o token concede acesso. O token de autenticação concede acesso a um conjunto limitado de operações de serviço em lote. Atualmente, o único valor suportado para a propriedade de acesso é 'job', que concede acesso a todas as operações relacionadas ao Job que contém a Tarefa.

ElevationLevel

O nível de elevação do usuário automático. O valor padrão é nonAdmin.

AutoUserScope

O escopo do usuário automático. O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Tarefa deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa alterar o registro de uma forma que possa afetar outras tarefas.

string

Uma string opaca que representa a localização de um Nó de Computação ou de uma Tarefa que já foi executada anteriormente. Você pode passar o affinityId de um nó para indicar que essa tarefa precisa rodar nesse nó de computação. Observe que isso é apenas uma afinidade suave. Se o Nó de Computação de destino estiver ocupado ou indisponível no momento em que a Tarefa for agendada, a Tarefa será agendada em outro lugar.

string

O ID do aplicativo a ser implantado. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

string

A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. Se isso for omitido em um Pool, e nenhuma versão padrão for especificada para esta aplicação, a solicitação falha com o código de erro InvalidApplicationPackageReferences, e o código de status HTTP 409. Se isso for omitido em uma tarefa, e nenhuma versão padrão for especificada para essa aplicação, a tarefa falha com um erro de pré-processamento.

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

BatchErrorMessage

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

BatchErrorDetail[]

Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

string

Um identificador que especifica o significado da propriedade Value.

string

As informações adicionais incluídas na resposta de erro.

string

O código de idioma da mensagem de erro.

string

O texto da mensagem.

string (arm-id)

A ID de recurso do ARM da identidade atribuída pelo usuário.

integer (int32)

O número máximo de vezes que a Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero. Note que esse valor controla especificamente o número de tentativas para o executável da Tarefa devido a um código de saída diferente de zero. O serviço lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetição for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não tenta novamente a Tarefa após a primeira tentativa. Se a contagem máxima de repetição for -1, o serviço do Lote repetirá a Tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem novas tentativas).

string (duration)

O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa começa. Se a Tarefa não for concluída dentro do tempo limite, o serviço Batch a encerra. Se isso não for especificado, não há limite de tempo para quanto tempo a Tarefa pode durar.

string (duration)

O tempo mínimo para manter o diretório Tarefa no Nó de Computação onde ela foi executada, a partir do momento em que ela é concluída. Após esse tempo, o serviço Batch pode deletar o diretório Task e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório Tarefa será mantido por 7 dias, a menos que o Nó de Computação seja removido ou o Trabalho seja excluído.

ContainerHostBatchBindMountEntry[]

Os caminhos que você deseja montar na tarefa de contêiner. Se essa matriz for nula ou não estiver presente, a tarefa de contêiner montará toda a unidade de disco temporária no Windows (ou AZ_BATCH_NODE_ROOT_DIR no Linux). Ele não montará nenhum caminho de dados no contêiner se essa matriz estiver definida como vazia.

string

Opções adicionais para o comando de criação de contêiner. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além das controladas pelo Serviço de Lote.

string

A imagem a ser usada para criar o contêiner onde a tarefa será executada. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da Imagem, a tag ":latest" é usada como padrão.

ContainerRegistryReference

O registro privado que contém a imagem do contêiner. Essa configuração pode ser omitida se já foi fornecida na criação do Pool.

ContainerWorkingDirectory

A localização do diretório de trabalho Container Task. O padrão é 'taskWorkingDirectory'.

BatchAffinityInfo

Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar a nova Tarefa.

BatchApplicationPackageReference[]

Uma lista de Pacotes que o serviço Batch irá implantar no Nó de Computação antes de executar a linha de comando. Os pacotes de aplicação são baixados e implantados em um diretório compartilhado, não no diretório de trabalho Tarefa. Portanto, se um pacote referenciado já estiver no Nó e atualizado, ele não é baixado novamente; a cópia existente no Nó de Computação é utilizada. Se um Pacote referenciado não puder ser instalado, por exemplo, porque o pacote foi deletado ou porque o download falhou, a Tarefa falha.

AuthenticationTokenSettings

As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote. Se essa propriedade for definida, o serviço Batch fornece à Tarefa um token de autenticação que pode ser usado para autenticar operações do serviço Batch sem exigir uma chave de acesso à Conta. O token é fornecido por meio da variável de ambiente AZ_BATCH_AUTHENTICATION_TOKEN. As operações que a Tarefa pode realizar usando o token dependem das configurações. Por exemplo, uma Tarefa pode solicitar permissões de Trabalho para adicionar outras Tarefas ao Trabalho, ou verificar o status do Trabalho ou de outras Tarefas sob o Trabalho.

string

A linha de comando da Tarefa. Para Tarefas multiinstância, a linha de comando é executada como a Tarefa principal, após a Tarefa principal e todas as subtarefas terem terminado de executar a linha de comando de coordenação. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se quiser aproveitar esses recursos, invoque o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://v4.hkg1.meaqua.org/azure/batch/batch-compute-node-environment-variables).

BatchTaskConstraints

As restrições de execução que se aplicam a esta Tarefa. Se você não especificar restrições, o maxTaskRetryCount é o maxTaskRetryCount especificado para o Trabalho, o maxWallClockTimeTime é infinito e o retentionTime é de 7 dias.

BatchTaskContainerSettings

As configurações do contêiner sob o qual a Tarefa é executada. Se o pool que executará essa tarefa tiver containerConfiguration ativado, isso também deve ser definido. Se o pool que executará essa tarefa não tiver containerConfiguration ativado, isso não deve ser definido. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados no contêiner, todas as variáveis do ambiente Tarefa são mapeadas no contêiner, e a linha de comando Tarefa é executada no contêiner. Arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco hospedeiro, o que significa que APIs de arquivos Batch não conseguirão acessar esses arquivos.

BatchTaskDependencies

As tarefas das quais essa tarefa depende. Essa Tarefa não será agendada até que todas as Tarefas das quais ela depende tenham sido concluídas com sucesso. Se alguma dessas Tarefas falhar e esgotar a contagem de tentativas de novo, essa Tarefa nunca será agendada. Se o Job não tiver usesTaskDependencies ativado como true, e esse elemento estiver presente, a solicitação falha com o código de erro TaskDependenciesNotSpecifiedOnJob.

string

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

EnvironmentSetting[]

Uma lista de configurações de variáveis de ambiente para a Tarefa.

ExitConditions

Como o serviço em lote deve responder quando a tarefa for concluída.

string

Uma cadeia que identifica de forma única a Tarefa dentro do Trabalho. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. O ID preserva minúsculas e minúsculas e não é sensível a minúsculas (ou seja, você pode não ter dois IDs dentro de um Job que diferem apenas por caso).

MultiInstanceSettings

Um objeto que indica que a tarefa é uma tarefa multiinstância e contém informações sobre como executar a tarefa multiinstância.

OutputFile[]

Uma lista de arquivos que o serviço Batch enviará do Nó de Computação após executar a linha de comando. Para Tarefas de múltiplas instâncias, os arquivos só serão carregados do Nó de Computação onde a Tarefa principal é executada.

integer (int32)

O número de slots de agendamento que a Tarefa precisava para executar. O padrão é 1. Uma Tarefa só pode ser agendada para rodar em um nó de computação se o nó tiver vagas de agendamento livres suficientes disponíveis. Para Tarefas de múltiplas instâncias, isso deve ser 1.

ResourceFile[]

Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Para Tarefas multiinstância, os arquivos de recurso serão baixados apenas para o Nó de Computação onde a Tarefa principal é executada. Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.

UserIdentity

A identidade do usuário sob a qual a Tarefa é executada. Se omitida, a Tarefa roda como um usuário não administrativo exclusivo da Tarefa.

BatchTaskIdRange[]

A lista de intervalos de IDs de Tarefa dos quais essa Tarefa depende. Todas as Tarefas em todos os intervalos devem ser concluídas com sucesso antes que a Tarefa dependente possa ser agendada.

string[]

A lista de IDs de Tarefa da qual essa Tarefa depende. Todas as Tarefas desta lista devem ser concluídas com sucesso antes que a Tarefa dependente possa ser agendada. A coleção de taskIds é limitada a 64.000 caracteres no total (ou seja, o comprimento combinado de todos os IDs de tarefa). Se a coleção taskIds exceder o comprimento máximo, a solicitação de Adicionar Tarefa falha com o código de erro TaskDependencyListTooLong. Nesse caso, considere usar intervalos de IDs de tarefa.

integer (int32)

O último ID de Tarefa da faixa.

integer (int32)

O primeiro ID de Tarefa da alcance.

boolean

Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é falso (modo de leitura/gravação). Para o Linux, se você montar esse caminho como um modo de leitura/gravação, isso não significa que todos os usuários no contêiner tenham o acesso de leitura/gravação para o caminho, isso depende do acesso na VM do host. Se esse caminho for montado somente leitura, todos os usuários dentro do contêiner não poderão modificar o caminho.

ContainerHostDataPath

O caminho que será montado no cliente do contêiner pode ser selecionado.

BatchNodeIdentityReference

A referência à identidade atribuída pelo usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha.

string (password)

A senha para fazer logon no servidor do Registro.

string (uri)

A URL do registro. Se omitido, o padrão será "docker.io".

string

O nome de usuário a ser conectado ao servidor do Registro.

string

O nome da variável de ambiente.

string

O valor da variável de ambiente.

integer (int32)

Um código de saída de processo.

ExitOptions

Como o serviço Batch deve responder se a Tarefa sair com esse código de saída.

integer (int32)

O último código de saída na faixa.

ExitOptions

Como o serviço Batch deve responder se a Tarefa sair com um código de saída no intervalo do início ao fim (inclusivo).

integer (int32)

O primeiro código de saída na faixa.

ExitOptions

Como o serviço Batch deve responder caso a Tarefa falhe com uma condição de saída não coberta por nenhuma das outras propriedades. Esse valor é usado se a Tarefa sair com qualquer código de saída não nulo não listado nas coleções exitCodes ou exitCodeRanges, com erro de pré-processamento se a propriedade pré-ErrorProcessamento não estiver presente, ou com erro de upload de arquivo se a propriedade ErrorCarregamento não estiver presente. Se você quiser comportamento não padrão no código de saída 0, deve listá-lo explicitamente usando a coleção exitCodes ou exitCodeRanges.

ExitCodeRangeMapping[]

Uma lista dos intervalos de código de saída de tarefa e como o serviço Batch deve responder a eles.

ExitCodeMapping[]

Uma lista de códigos individuais de saída de Tarefa e como o serviço Batch deve responder a eles.

ExitOptions

Como o serviço de lote deve responder caso ocorra um erro de upload de arquivo. Se a Tarefa saiu com um código de saída especificado via exitCodes ou exitCodeRanges, e então encontrou um erro de upload de arquivo, então a ação especificada pelo código de saída tem precedência.

ExitOptions

Como o serviço Batch deve responder caso a Tarefa não inicie devido a um erro.

DependencyAction

Uma ação que o serviço Batch realiza em Tarefas que dependem dessa Tarefa. Os valores possíveis são 'satisfizer' (permitindo que tarefas dependentes progridam) e 'bloqueio' (tarefas dependentes continuam esperando). O batch ainda não suporta o cancelamento de tarefas dependentes.

BatchJobActionKind

Uma ação a ser tomada no Trabalho contendo a Tarefa, se a Tarefa for concluída com a condição de saída dada e a propriedade onTaskFailed do Trabalho for 'performExitOptionsJobAction'. O padrão é nenhum para o código de saída 0 e termina para todas as outras condições de saída. Se a propriedade onTaskFailed do Job for noaction, então especificar essa propriedade retorna um erro e a solicitação de adicionar Task falha com um erro de valor de propriedade inválido; se você está chamando diretamente a API REST, o código de status HTTP é 400 (Solicitação Ruim).

ResourceFile[]

Uma lista de arquivos que o serviço Batch baixará antes de executar a linha de comando de coordenação. A diferença entre arquivos de recursos comuns e arquivos de recursos de Tarefa é que arquivos de recursos comuns são baixados para todas as subtarefas, incluindo a primária, enquanto arquivos de recursos de Tarefa são baixados apenas para a primária. Também note que esses arquivos de recursos não são baixados para o diretório de trabalho Tarefa, mas sim para o diretório raiz de Tarefa (um diretório acima do diretório de trabalho). Há um tamanho máximo para a lista de arquivos de recurso. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deverá ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.

string

A linha de comando para rodar em todos os Nós de Computação para permitir que eles coordenem quando o principal executa o comando principal de Tarefa. Uma linha de comando típica de coordenação inicia um serviço em segundo plano e verifica se o serviço está pronto para processar mensagens entre nós.

integer (int32)

O número de Nós de Computação exigidos pela Tarefa. Se omitido, o padrão é 1.

OutputFileDestination

O destino para o(s) arquivo(s) de saída.

string

Um padrão indicando qual(s) arquivo(s) enviar. Tanto caminhos relativos quanto absolutos são suportados. Caminhos relativos são relativos ao diretório de trabalho Tarefa. Os seguintes coringas são suportados: * corresponde a 0 ou mais caracteres (por exemplo, o padrão abc* corresponderia a abc ou abcdef), ** corresponde a qualquer diretório, ? corresponde a qualquer caractere, [ABC] corresponde a um caractere entre parênteses, e [A-C] corresponde a um caractere na faixa. Os parênteses podem incluir uma negação para corresponder a qualquer caractere não especificado (por exemplo, [!abc] corresponde a qualquer caractere que não seja a, b ou c). Se um nome de arquivo começar com "." ele é ignorado por padrão, mas pode ser correspondido especificando explicitamente (por exemplo ,.gif não corresponderá .a.gif, mas.gif vai). Um exemplo simples: ***.txt corresponde a qualquer arquivo que não comece em '.' e termine com .txt no diretório de trabalho Task ou em qualquer subdiretório. Se o nome do arquivo contiver um caractere coringa, ele pode ser escapado usando colchetes (por exemplo, abc[] corresponderia a um arquivo chamado abc). Note que tanto \ quanto / são tratados como separadores de diretórios no Windows, mas apenas / é no Linux. Variáveis de ambiente (%var% no Windows ou $var no Linux) são expandidas antes da aplicação do padrão.

OutputFileUploadConfig

Opções adicionais para a operação de upload, incluindo sob quais condições realizar o upload.

string (uri)

A URL do contêiner dentro do Azure Blob Storage para o qual enviar o(s) arquivo(s). Se não estiver usando uma identidade gerenciada, a URL deve incluir uma Assinatura de Acesso Compartilhada (SAS) concedendo permissões de escrita ao contêiner.

BatchNodeIdentityReference

A referência à identidade atribuída pelo usuário para usar para acessar o Azure Blob Storage especificada pelo containerUrl. A identidade deve ter acesso de escrita ao contêiner Azure Blob Storage.

string

O blob de destino ou diretório virtual dentro do contêiner Azure Storage. Se filePattern se referir a um arquivo específico (ou seja, não contiver curingas), então path é o nome do blob para o qual enviar esse arquivo. Se filePattern contém um ou mais curingas (e, portanto, pode corresponder a vários arquivos), então path é o nome do diretório virtual do blob (que é preencaminhado a cada nome do blob) para o qual é enviado o(s) arquivo(s). Se omitidos, o(s) arquivo(s) são enviados para a raiz do contêiner com um nome de blob correspondente ao nome do arquivo.

OutputFileUploadHeader[]

Uma lista de pares nome-valor para cabeçalhos a serem usados no upload de arquivos de saída. Esses cabeçalhos serão especificados ao enviar arquivos para o Azure Storage. Documento oficial sobre cabeçalhos permitidos ao enviar blobs: https://v4.hkg1.meaqua.org/rest/api/storageservices/put-blob#request-headers-all-blob-types.

OutputFileBlobContainerDestination

Um local no armazenamento de blob do Azure para onde os arquivos são enviados.

OutputFileUploadCondition

As condições sob as quais o arquivo de saída da Tarefa ou conjunto de arquivos deve ser carregado. O padrão é a conclusão de tarefas.

string

O nome insensível a maiúsculas minúsculas do cabeçalho a ser usado ao fazer upload dos arquivos de saída.

string

O valor do cabeçalho a ser usado ao fazer upload dos arquivos de saída.

string

O nome do container de armazenamento está na conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.

string

O prefixo de blob a ser usado ao baixar blobs de um contêiner do Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados.

string

O atributo de modo de permissão de arquivo no formato octal. Essa propriedade se aplica apenas a arquivos sendo baixados para os Nós de Computação do Linux. Ele será ignorado se for especificado para um ResourceFile que será baixado em um Nó de Computação do Windows. Se essa propriedade não for especificada para um Nó de Computação Linux, então um valor padrão de 0770 é aplicado ao arquivo.

string

A localização no Nó de Computação para onde baixar o(s) arquivo(s), relativa ao diretório de trabalho da Tarefa. Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual baixar os arquivos. No caso em que o filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será retida na íntegra e acrescentada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').

string (uri)

A URL do arquivo a ser baixado. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para o Armazenamento de Blobs do Azure, ela deverá ser legível de nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.

BatchNodeIdentityReference

A referência à identidade atribuída pelo usuário para usar para acessar o Azure Blob Storage especificada por storageContainerUrl ou httpUrl.

string (uri)

A URL do contêiner de blob no Armazenamento de Blobs do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Essa URL deve ser legível e listável de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL para o contêiner para permitir acesso público.

AutoUserSpecification

O usuário automático sob o qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.

string

O nome da identidade do usuário sob a qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.