@azure/batch package

Classe cliente para acessar o serviço Batch do Azure.

Os resultados e erros de uma execução de uma fórmula de dimensionamento automático do Pool.

Erro ao executar ou avaliar uma fórmula de dimensionamento automático do Pool.

Especifica as opções para o usuário automático que executa uma tarefa Lote do Azure.

Os parâmetros de configuração usados para executar a atualização automática do sistema operacional.

Informações usadas para conectar a um contêiner Armazenamento do Azure usando Blobfuse.

Informações usadas para conectar a um compartilhamento de arquivos do Azure.

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

Contém informações sobre um aplicativo em uma Conta do Lote do Azure.

Uma referência a um pacote a ser implantado em Nós de Computação.

Especifica as características de um 'pool automático' temporário. O serviço lote criará esse pool automático quando o trabalho for enviado.

Informações usadas para se conectar a um sistema de arquivos CIFS.

Parâmetros opcionais para o cliente.

A configuração para pools habilitados para contêineres.

O resultado da criação de uma coleção de Tarefas para um Trabalho.

Especifica as Configurações de Disco efêmero para o disco do sistema operacional usado pela VM (nó de computação).

Uma resposta de erro recebida do serviço Lote do Azure.

Um item de informação adicional incluído em uma resposta de erro do Lote do Azure.

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Um pool nat de entrada que pode ser usado para abordar portas específicas em nós de computação em um pool de lote externamente.

Um Trabalho Lote do Azure.

As restrições de execução de um trabalho.

Parâmetros para criar um Lote do Azure Job.

Parâmetros para desabilitar um Trabalho em Lote do Azure.

Contém informações sobre a execução de um Job no serviço Lote do Azure.

Especifica detalhes de uma tarefa do Gerenciador de Trabalhos. A Tarefa Gerenciador de Trabalhos é iniciada automaticamente quando o Trabalho é criado. O serviço do Lote tenta agendar a Tarefa do Gerenciador de Trabalho antes de qualquer outra Tarefa no Trabalho. Ao reduzir um pool, o serviço Lote tenta preservar nós em que as Tarefas do Gerenciador de Trabalho estão em execução pelo maior tempo possível (ou seja, nós de computação executando tarefas 'normais' são removidos antes que nós de computação executem tarefas do Gerenciador de Trabalho). Quando uma tarefa do Gerenciador de Trabalhos falha e precisa ser reiniciada, o sistema tenta agendá-la com a prioridade mais alta. Se não houver nós de computação ociosos disponíveis, o sistema poderá encerrar uma das Tarefas em execução no Pool e devolvê-la à fila para abrir espaço para que a Tarefa do Gerenciador de Trabalho seja reiniciada. Observe que uma tarefa do Gerenciador de Trabalhos em um trabalho não tem prioridade sobre tarefas em outros trabalhos. Em Trabalhos, apenas as prioridades de nível de trabalho são observadas. Por exemplo, se um Job Manager em um trabalho de prioridade 0 precisar ser reiniciado, ele não deslocará tarefas de um trabalho de prioridade 1. O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação.

(Essa propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) A configuração de rede do trabalho.

O status das tarefas preparação do trabalho e liberação de trabalho em um nó de computação.

Uma Tarefa de Preparação de Trabalho a ser executada antes de qualquer Tarefa do Trabalho em qualquer nó de computação especificado. Você pode usar a Preparação do Trabalho para preparar um nó para executar Tarefas para o Trabalho. As atividades normalmente executadas na Preparação do Trabalho incluem: Baixar arquivos de recursos comuns usados por todas as Tarefas no Trabalho. A Tarefa de Preparação de Trabalho pode baixar esses arquivos de recurso comuns para o local compartilhado no Nó. (AZ_BATCH_NODE_ROOT_DIR\shared) ou iniciando um serviço local no Nó para que todas as tarefas desse trabalho possam se comunicar com ele. Se a Tarefa preparação do trabalho falhar (ou seja, esgota sua contagem de repetições antes de sair com o código de saída 0), o Lote não executará Tarefas deste Trabalho no Nó. O Nó de Computação permanece inelegível para executar tarefas deste trabalho até que ele seja reimageado. O Nó de Computação permanece ativo e pode ser usado para outros trabalhos. A Tarefa preparação do trabalho pode ser executada várias vezes no mesmo nó. Portanto, você deve escrever a Tarefa de Preparação de Trabalho para lidar com a re-execução. Se o Nó for reinicializado, a Tarefa de Preparação de Trabalho será executada novamente no Nó de Computação antes de agendar qualquer outra Tarefa do Trabalho, se a execução novaMenteNodeRebootAfterSuccess for verdadeira ou se a Tarefa de Preparação do Trabalho não tiver sido concluída anteriormente. Se o Nó for reimageado, a Tarefa de Preparação do Trabalho será executada novamente antes de agendar qualquer Tarefa do Trabalho. O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação.

Contém informações sobre a execução de uma tarefa de preparação de trabalho em um nó de computação.

Uma tarefa de liberação de trabalho a ser executada na conclusão do trabalho em qualquer nó de computação em que o trabalho foi executado. A Tarefa de Liberação de Trabalho é executada quando o Trabalho termina, devido a um dos seguintes: o usuário chama a API de Trabalho de Encerramento ou a API De Exclusão de Trabalho enquanto o Trabalho ainda está ativo, a restrição de tempo máximo do relógio de parede do Trabalho é atingida e o Trabalho ainda está ativo ou a Tarefa Gerenciador de Trabalhos concluída, e o Trabalho é configurado para terminar quando o Gerenciador de Trabalhos for concluído. A Tarefa de Liberação de Trabalho é executada em cada nó em que as tarefas do trabalho foram executadas e a Tarefa de Preparação do Trabalho foi executada e concluída. Se você refazer a imagem de um Nó depois que ele executar a Tarefa de Preparação do Trabalho e o Trabalho terminar sem nenhuma tarefa adicional do trabalho em execução nesse nó (e, portanto, a Tarefa de Preparação do Trabalho não for executada novamente), a Tarefa de Liberação de Trabalho não será executada nesse nó de computação. Se um nó for reinicializado enquanto a Tarefa de Liberação de Trabalho ainda estiver em execução, a Tarefa de Liberação de Trabalho será executada novamente quando o Nó de Computação for iniciado. O Trabalho não está marcado como concluído até que todas as Tarefas de Liberação de Trabalho tenham sido concluídas. A Tarefa de Liberação de Trabalho é executada em segundo plano. Ele não ocupa um slot de agendamento; ou seja, ele não conta para o limite taskSlotsPerNode especificado no Pool.

Contém informações sobre a execução de uma tarefa de liberação de trabalho em um nó de computação.

Um Agendamento de Trabalho que permite trabalhos recorrentes especificando quando executar Trabalhos e uma especificação usada para criar cada Trabalho.

O agendamento de acordo com o qual os Trabalhos serão criados. Todas as horas são corrigidas respectivamente para UTC e não são afetadas pelo horário de verão.

Parâmetros para criar um Lote do Azure Job Schedule

Contém informações sobre trabalhos que foram e serão executados em um Agendamento de Trabalho.

Estatísticas de uso de recursos para um Agendamento de Trabalho.

Parâmetros para atualizar um Lote do Azure Job Schedule.

Um erro encontrado pelo serviço do Lote ao agendar um trabalho.

Especifica os detalhes dos Trabalhos a serem criados em um agendamento.

Estatísticas de uso de recursos para um trabalho.

Parâmetros para encerrar um Trabalho em Lote do Azure.

Parâmetros para atualização de um Lote do Azure Job.

O serviço do Lote não atribui nenhum significado a esses metadados; é apenas para o uso do código do usuário.

Um nó de computação no serviço do Lote.

O agente do Nó de Computação em Lote é um programa que é executado em cada Nó de Computação no Pool e fornece recursos do Lote no Nó de Computação.

O número de nós de computação em cada estado do Nó de Computação.

Opções para desalocar um Nó de Computação.

Parâmetros para desabilitar o agendamento em um Nó de Computação em Lote do Azure.

A configuração do ponto de extremidade para o Nó de Computação.

Um erro encontrado por um Nó de Computação.

Informações sobre um arquivo ou diretório em um Nó de Computação.

A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

Informações sobre o Nó de Computação no qual uma Tarefa foi executada.

Para posicionamento regional, os nós no pool serão alocados na mesma região. Para o posicionamento zonal, os nós no pool serão distribuídos entre diferentes zonas com melhor balanceamento de esforço.

Parâmetros para reinicializar um Nó de Computação em Lote do Azure.

Parâmetros para reimaginar um Nó de Computação em Lote do Azure.

As configurações de logon remoto para um Nó de Computação.

Parâmetros para remover nós de um Lote do Azure Pool.

Parâmetros para criar uma conta de usuário para acesso RDP ou SSH em um Nó de Computação em Lote do Azure.

Parâmetros para atualizar uma conta de usuário para acesso RDP ou SSH em um Nó de Computação em Lote do Azure.

A configuração da exibição da instância de extensão da máquina virtual.

Configurações do disco do sistema operacional do nó de computação (VM).

Um Pool no serviço Lote do Azure.

Parâmetros para criar um Lote do Azure Pool.

Parâmetros para habilitar a escalonabilidade automática em um Lote do Azure Pool.

A configuração do ponto de extremidade para um pool.

Parâmetros para avaliar uma fórmula de dimensionamento automático em um Pool de Lotes do Azure.

A identidade do pool do Lote, se configurada.

A referência de uma das identidades do pool para criptografar o disco. Essa identidade será usada para acessar o cofre de chaves.

Especifica como um trabalho deve ser atribuído a um pool.

O número de nós de computação em cada estado para um pool.

Parâmetros para substituir propriedades em um Pool de Lotes do Azure.

Parâmetros para alterar o tamanho de um Lote do Azure Pool.

Estatísticas relacionadas ao consumo de recursos por nós de computação em um pool.

Especificação para criar um novo Pool.

Contém estatísticas de utilização e uso de recursos para o tempo de vida de um pool.

Parâmetros para atualização de um Lote do Azure Pool.

Métricas de uso para um pool em um intervalo de agregação.

Estatísticas relacionadas às informações de uso do Pool.

A configuração de endereço IP público da configuração de rede de um pool.

O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, mesmo que o Nó de Computação não tenha sido reinicializado. Deve-se tomar cuidado especial para evitar StartTasks que criam o processo de separação ou instalam/iniciam serviços do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask.

Informações sobre um StartTask em execução em um Nó de Computação.

Informações sobre uma subtarefa do Lote do Azure.

Uma referência à imagem do Marketplace de Máquinas Virtuais do Azure e informações adicionais sobre a Imagem.

O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação.

Restrições de execução a serem aplicadas a uma Tarefa.

Contém informações sobre o contêiner que uma Tarefa está executando.

As configurações de contêiner de uma Tarefa.

A Tarefa conta para um trabalho.

As contagens Task e TaskSlot para um trabalho.

Parâmetros para criar uma tarefa Lote do Azure.

Resultado para uma única tarefa criada como parte de uma operação de coleção de tarefas adicionadas.

Especifica as dependências de uma Tarefa. Qualquer tarefa especificada explicitamente ou dentro de um intervalo de dependência deve ser concluída antes que a Tarefa dependente seja agendada.

Informações sobre a execução de uma Tarefa.

Informações sobre uma falha de tarefa.

Uma coleção de Lote do Azure Tasks para adicionar.

O início e o final do intervalo são inclusivos. Por exemplo, se um intervalo tiver início 9 e término 12, ele representará Tarefas '9', '10', '11' e '12'.

Informações sobre uma tarefa em execução em um Nó de Computação.

Especifica como as tarefas devem ser distribuídas entre nós de computação.

O TaskSlot conta para um trabalho.

Estatísticas de uso de recursos para uma Tarefa.

Especifica as configurações de segurança, como inicialização segura e vTPM usadas durante a criação da máquina virtual.

A identidade atribuída pelo usuário

Especifica as configurações de perfil de segurança para o disco gerenciado. Observação: ele só pode ser definido para VMs confidenciais e necessário ao usar VMs confidenciais.

Uma referência a uma imagem do Máquinas Virtuais do Azure Marketplace ou a uma imagem da galeria de computação do Azure. Para verificar a lista de todas as referências de imagens do Azure Marketplace pelo Lote do Azure, veja a operação 'Listar Imagens Suportadas'.

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

Um registro de contêiner privado.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Configurações que serão usadas pelos discos de dados associados aos Nós de Computação no Pool. Ao usar discos de dados anexados, você precisa montar e formatar os discos de dentro de uma VM para usá-los.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

A referência de Chave Gerenciada pelo Cliente para criptografar o Disco.

A configuração de criptografia de disco aplicada em nós de computação no pool. A configuração de criptografia de disco não é suportada em pool Linux criado com a Imagem da Galeria de Computação do Azure.

A ID do recurso ARM do conjunto de criptografia de disco.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Uma variável de ambiente a ser definida em um processo de tarefa.

Parâmetros opcionais.

Como o serviço lote deve responder se uma Tarefa for encerrada com um código de saída específico.

Um intervalo de códigos de saída e como o serviço do Lote deve responder aos códigos de saída dentro desse intervalo.

Especifica como o serviço do Lote deve responder quando a Tarefa for concluída.

Especifica como o serviço do Lote responde a uma condição de saída específica.

As propriedades de um arquivo em um Nó de Computação.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Especifica configurações específicas do ponto de extremidade do host.

Contém a marca IP associada ao endereço IP público.

Um ponto de extremidade de entrada em um Nó de Computação.

O status de exibição da instância.

Parâmetros opcionais.

Propriedades usadas para criar uma conta de usuário em um Nó de Computação do Linux.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Os parâmetros de disco gerenciado.

O sistema de arquivos a ser montado em cada nó.

Tarefas de várias instâncias geralmente são usadas para dar suporte a Tarefas de MPI. No caso do MPI, se alguma das subtarefas falhar (por exemplo, devido à saída com um código de saída diferente de zero), toda a Tarefa de várias instâncias falhará. Em seguida, a Tarefa de várias instâncias é encerrada e repetida, até o limite de repetição.

Representa um par nome-valor.

A configuração de rede de um pool.

Uma regra de grupo de segurança de rede a ser aplicada a um ponto de extremidade de entrada.

Informações usadas para se conectar a um sistema de arquivos NFS.

Em cada upload de arquivo, o serviço lote grava dois arquivos de log no nó de computação, 'fileuploadout.txt' e 'fileuploaderr.txt'. Esses arquivos de log são usados para saber mais sobre uma falha específica.

Especifica um destino de upload de arquivo dentro de um contêiner de armazenamento de blob do Azure.

O destino para o qual um arquivo deve ser carregado.

Opções para uma operação de upload de arquivo de saída, incluindo sob quais condições executar o upload.

Um par nome-valor de cabeçalho HTTP

Opções para o método byPage

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

Parâmetros opcionais.

Especifica as configurações de ProxyAgent ao criar a máquina virtual.

Parâmetros opcionais.

Parâmetros opcionais.

Informações sobre o trabalho mais recente a ser executado na Agenda de Trabalho.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Erro ao redimensionar um pool.

Parâmetros opcionais.

Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.

Os parâmetros de configuração usados durante a execução de uma atualização sem interrupção.

Especifica as configurações de perfil de segurança para a máquina virtual ou o conjunto de dimensionamento de máquinas virtuais.

Especifica a ID de referência do artefato de serviço usada para definir a mesma versão de imagem para todas as máquinas virtuais no conjunto de dimensionamento ao usar a versão de imagem 'mais recente'.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Descreve uma política de atualização – automática, manual ou sem interrupção.

Os arquivos de log de serviço do Lote do Azure carregam parâmetros para um Nó de Computação.

O resultado do carregamento de arquivos de log de serviço do Lote de um Nó de Computação específico.

Parâmetros opcionais.

Propriedades usadas para criar um usuário usado para executar Tarefas em um Nó de Computação Lote do Azure.

A definição da identidade do usuário na qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

A configuração para extensões de máquina virtual.

O modo de exibição da instância de extensão da VM.

A configuração para Compute Nodes in a Pool baseada na infraestrutura Máquinas Virtuais do Azure.

Informações sobre o estado atual da máquina virtual.

Configurações do sistema operacional Windows para aplicar à máquina virtual.

Propriedades usadas para criar uma conta de usuário em um nó de computação do Windows.

Alocação Enums de Estado

Enums AutoUserScope

A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído.

BatchErrorSourceCategory enums

Enums do BatchJobAction

Enums BatchJobDefaultOrder

BatchJobPreparationTaskState enums

Ems enums BatchJobReleaseTaskState

BatchJobScheduleState enums

Enums do BatchJobState

BatchNodeDeallocateOption enums

BatchNodeDeallocationOption enums

BatchNodeDisableSchedulingOption enums

Enums BatchNodeFillType

Emums BatchNodePlacementPolicyType

Enums BatchNodeRebootKind

Enums BatchNodeReimageOption

Enus do BatchNodeState

Enums BatchPoolIdentityType

Emums de BatchPoolLifetimeOption

Enums do BatchPoolState

Enums BatchStartTaskState

Enums BatchSubtaskState

BatchTaskAddStatus enums

Enums BatchTaskExecutionResult

Enums TaskFail

Enums BatchTaskState

Enums CachingType

Os caminhos que serão montados no contêiner da tarefa de contêiner.

Enums ContainerType

ContainerWorkingDirectory enums

Uma interface que descreve uma página de resultados.

Enums DependencyAction

Especifica a posição efêmera do disco do sistema operacional para todos os nós de computação (VMs) do pool. Essa propriedade pode ser usada pelo usuário na solicitação para escolher em qual local o sistema operacional deve estar. Por exemplo, armazene espaço em disco em cache para provisionamento de disco do sistema operacional efêmero. Para mais informações sobre requisitos de tamanho de disco do Sistema Operacional Efemero, consulte os requisitos de tamanho de disco para Windows VMs em https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements e VMs Linux em https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Enums DisableBatchJobOption

Enums DiskEncryptionTarget

DynamicVNetAssignmentScope enums

Enums de Elevação

HostEndpointSettingsModeTypes enums

As famílias de IP usadas para especificar as versões de IP disponíveis para o pool.

Enums ImageVerificationType

InboundEndpointProtocol enums

IPAddressProvisioningType enums

Enums LoginMode

NetworkSecurityGroupRuleAccess enums

OSType enums

Enums OutputFileUploadCondition

ProgramamentoEstátuos enums

Enums SecurityEncryptionTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings.

Nível de código.

Enumerações StorageAccountType

Enums UpgradeMode

A versão do serviço Lote do Azure.