Partilhar via


Nodes - List Nodes

Lista os nós de computação no pool especificado.

GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01
GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&$select={$select}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string (uri)

Ponto de extremidade da conta em lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).

poolId
path True

string

O ID do Pool de onde queres listar os Nós de Computação.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

$filter
query

string

Uma cláusula $filter OData. Para mais informações sobre como construir este filtro, veja https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

$select
query

string[]

Uma cláusula OData $select.

maxresults
query

integer (int32)

minimum: 1
maximum: 1000

O número máximo de itens a serem retornados na resposta. Podem ser devolvidos um máximo de 1000 candidaturas.

timeOut
query

integer (int32)

O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for superior a 30, será usado o padrão em vez disso.".

Cabeçalho do Pedido

Name Necessário Tipo Description
client-request-id

string

A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Se o servidor deve retornar o client-request-id na resposta.

ocp-date

string (date-time-rfc7231)

A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name Tipo Description
200 OK

BatchNodeListResult

O pedido foi bem-sucedido.

Cabeçalhos

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name Description
https://batch.core.windows.net//.default

Exemplos

Node list

Pedido de amostra

GET {endpoint}/pools/poolId/nodes?api-version=2025-06-01


Resposta da amostra

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T22:22:27.2236818Z",
      "lastBootTime": "2025-11-22T22:22:24.4634125Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T22:22:27.2236818Z",
        "endTime": "2025-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_2-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:37:31.4285526Z",
      "lastBootTime": "2025-11-22T19:37:28.623369Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:37:31.4285526Z",
        "endTime": "2025-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:36:51.0013378Z",
      "lastBootTime": "2025-11-22T19:36:48.21721Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:36:51.0013378Z",
        "endTime": "2025-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definições

Name Description
AutoUserScope

Enums AutoUserScope

AutoUserSpecification

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

BatchError

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

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

BatchErrorMessage

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

BatchErrorSourceCategory

BatchErrorSourceCategory enums

BatchNode

Um nó de computação no serviço de lote.

BatchNodeAgentInfo

O agente Batch Compute Node é um programa que é executado em cada Nó de Computação no Pool e fornece capacidade de Batch no Nó de Computação.

BatchNodeEndpointConfiguration

A configuração do ponto de extremidade para o nó de computação.

BatchNodeError

Um erro encontrado por um nó de computação.

BatchNodeIdentityReference

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

BatchNodeListResult

O resultado da listagem dos nós de computação em um pool.

BatchNodeState

BatchNodeState enums

BatchStartTask

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um nó de computação desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é 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. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.

BatchStartTaskInfo

Informações sobre um StartTask em execução em um nó de computação.

BatchStartTaskState

Enums BatchStartTaskState

BatchTaskContainerExecutionInfo

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

BatchTaskContainerSettings

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

BatchTaskExecutionInfo

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

BatchTaskExecutionResult

Enums BatchTaskExecutionResult

BatchTaskFailureInfo

Informações sobre uma falha de tarefa.

BatchTaskInfo

Informações sobre uma tarefa em execução em um nó de computação.

BatchTaskState

Enums BatchTaskState

BatchVmImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

ContainerHostBatchBindMountEntry

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

ContainerHostDataPath

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

ContainerRegistryReference

Um registro de contêiner privado.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

ElevationLevel

Enums ElevationLevel

EnvironmentSetting

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

InboundEndpoint

Um ponto de extremidade de entrada em um nó de computação.

InboundEndpointProtocol

InboundEndpointProtocol enums

NameValuePair

Representa um par nome-valor.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados para um nó de computação.

SchedulingState

ProgramaçãoEstado enums

UserIdentity

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

VirtualMachineInfo

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

AutoUserScope

Enums AutoUserScope

Valor Description
task

Especifica que o serviço deve criar um novo utilizador para a Tarefa.

pool

Especifica que a Tarefa corre como a Conta de utilizador automática comum, criada em cada Nó de Computação de um Pool.

AutoUserSpecification

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

Name Tipo Description
elevationLevel

ElevationLevel

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

scope

AutoUserScope

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

BatchError

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

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

message

BatchErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.

value

string

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

BatchErrorMessage

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

Name Tipo Description
lang

string

O código da linguagem da mensagem de erro.

value

string

O texto da mensagem.

BatchErrorSourceCategory

BatchErrorSourceCategory enums

Valor Description
usererror

O erro deve-se a um problema do utilizador, como uma má configuração.

servererror

O erro deve-se a um problema interno no servidor.

BatchNode

Um nó de computação no serviço de lote.

Name Tipo Description
affinityId

string

Um identificador que pode ser passado ao adicionar uma Tarefa para solicitar que a Tarefa seja agendada neste Nó de Computação. Note que esta é 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.

allocationTime

string (date-time)

O momento em que esse nó de computação foi alocado para o pool. Este é o momento em que o nó de computação foi inicialmente alocado e não muda uma vez definido. Ele não é atualizado quando o Nó de Computação é recuperado ou antecipado.

endpointConfiguration

BatchNodeEndpointConfiguration

A configuração do ponto de extremidade para o nó de computação.

errors

BatchNodeError[]

A lista de erros que estão sendo encontrados atualmente pelo nó de computação.

id

string

A ID do nó de computação. Cada nó de computação adicionado a um pool recebe uma ID exclusiva. Sempre que um nó de computação é removido de um pool, todos os seus arquivos locais são excluídos e o ID é recuperado e pode ser reutilizado para novos nós de computação.

ipAddress

string

O endereço IP que outros nós podem usar para se comunicar com esse nó de computação. A cada nó de computação adicionado a um pool é atribuído um endereço IP exclusivo. Sempre que um nó de computação é removido de um pool, todos os seus arquivos locais são excluídos e o endereço IP é recuperado e pode ser reutilizado para novos nós de computação.

ipv6Address

string

O endereço IPv6 que outros nós podem usar para se comunicar com esse nó de computação. A cada nó de computação adicionado a um pool é atribuído um endereço IP exclusivo. Sempre que um nó de computação é removido de um pool, todos os seus arquivos locais são excluídos e o endereço IP é recuperado e pode ser reutilizado para novos nós de computação. Essa propriedade não estará presente se o Pool não estiver configurado para IPv6.

isDedicated

boolean

Se este Nó de Computação é um Nó de Computação dedicado. Se false, o nó de computação é um nó de computação spot/de baixa prioridade.

lastBootTime

string (date-time)

A última vez em que o nó de computação foi iniciado. Essa propriedade pode não estar presente se o estado do nó de computação estiver inutilizável.

nodeAgentInfo

BatchNodeAgentInfo

Informações sobre a versão do agente do Nó de Computação e a hora em que o Nó de Computação foi atualizado para uma nova versão.

recentTasks

BatchTaskInfo[]

Uma lista de Tarefas cujo estado foi alterado recentemente. Essa propriedade estará presente somente se pelo menos uma Tarefa tiver sido executada neste Nó de Computação desde que foi atribuída ao Pool.

runningTaskSlotsCount

integer (int32)

O número total de slots de agendamento usados atualmente executando Tarefas de Trabalho no Nó de Computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.

runningTasksCount

integer (int32)

O número total de tarefas de trabalho atualmente em execução no nó de computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.

schedulingState

SchedulingState

Se o nó de computação está disponível para agendamento de tarefas.

startTask

BatchStartTask

A Tarefa especificada para ser executada no Nó de Computação à medida que se junta ao Pool.

startTaskInfo

BatchStartTaskInfo

Informações de tempo de execução sobre a execução do StartTask no nó de computação.

state

BatchNodeState

O estado atual do nó de computação.

stateTransitionTime

string (date-time)

O momento em que o nó de computação entrou em seu estado atual.

totalTasksRun

integer (int32)

O número total de tarefas de trabalho concluídas no nó de computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.

totalTasksSucceeded

integer (int32)

O número total de tarefas de trabalho concluídas com êxito (com exitCode 0) no nó de computação. Isso inclui Tarefas do Gerenciador de Tarefas e Tarefas normais, mas não Preparação de Trabalho, Liberação de Trabalho ou Tarefas de Início.

url

string (uri)

A URL do nó de computação.

virtualMachineInfo

VirtualMachineInfo

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

vmSize

string

O tamanho da máquina virtual que hospeda o nó de computação. Para obter informações sobre tamanhos disponíveis de máquinas virtuais em Pools, consulte Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

BatchNodeAgentInfo

O agente Batch Compute Node é um programa que é executado em cada Nó de Computação no Pool e fornece capacidade de Batch no Nó de Computação.

Name Tipo Description
lastUpdateTime

string (date-time)

O momento em que o agente do Nó de Computação foi atualizado no Nó de Computação. Esta é a última vez que o agente do Compute Node foi atualizado para uma nova versão.

version

string

A versão do agente Batch Compute Node a correr no Compute Node. Este número de versão pode ser verificado com as notas de lançamento do agente Compute Node localizadas em https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

BatchNodeEndpointConfiguration

A configuração do ponto de extremidade para o nó de computação.

Name Tipo Description
inboundEndpoints

InboundEndpoint[]

A lista de endpoints de entrada acessíveis no Nó de Computação.

BatchNodeError

Um erro encontrado por um nó de computação.

Name Tipo Description
code

string

Um identificador para o erro Compute Node. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

errorDetails

NameValuePair[]

A lista de detalhes adicionais de erro relacionados com o erro do Nó de Computação.

message

string

Uma mensagem que descreve o erro Compute Node, destinada a ser adequada para exibição numa interface de utilizador.

BatchNodeIdentityReference

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

Name Tipo Description
resourceId

string (arm-id)

O ID de recurso ARM da identidade atribuída ao usuário.

BatchNodeListResult

O resultado da listagem dos nós de computação em um pool.

Name Tipo Description
odata.nextLink

string (uri)

O URL para obter o próximo conjunto de resultados.

value

BatchNode[]

A lista de Nós de Computação.

BatchNodeState

BatchNodeState enums

Valor Description
idle

O Nó de Computação não está atualmente a executar uma Tarefa.

rebooting

O Nó de Computação está a reiniciar.

reimaging

O Nó de Computação está a ser reimaginado.

running

O Nó de Computação está a executar uma ou mais Tarefas (exceto uma StartTask).

unusable

O Nó de Computação não pode ser usado para execução de tarefas devido a erros.

creating

O serviço Batch obteve a máquina virtual subjacente do Azure Compute, mas ainda não começou a juntar-se ao Pool.

starting

O serviço Batch está a iniciar na máquina virtual subjacente.

waitingforstarttask

O StartTask começou a correr no Nó de Computação, mas o waitForSuccess está definido e o StartTask ainda não foi concluído.

starttaskfailed

O StartTask falhou no Nó de Computação (e esgotou todas as tentativas), e o waitForSuccess está definido. O Nó de Computação não é utilizável para executar Tarefas.

unknown

O serviço Batch perdeu contacto com o Nó de Computação e não conhece o seu estado real.

leavingpool

O Nó de Computação está a sair do Pool, seja porque o utilizador o removeu explicitamente ou porque o Pool está a redimensionar-se ou a reduzir automaticamente.

offline

O Nó de Computação não está atualmente a executar uma Tarefa, e o agendamento de novas Tarefas para o Nó de Computação está desativado.

preempted

O nó de computação spot/low-priority foi antecipado. As tarefas que estavam sendo executadas no Nó de Computação quando ele foi antecipado serão reagendadas quando outro Nó de Computação estiver disponível.

upgradingos

O Nó de Computação está a passar por uma operação de atualização do sistema operativo.

deallocated

O Nó de Computação é realocado.

deallocating

O Nó de Computação está a desalocar.

BatchStartTask

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um nó de computação desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é 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. Cuidado especial deve ser tomado para evitar StartTasks que criam processos separatistas ou instalam/iniciam serviços a partir do diretório de trabalho StartTask, pois isso impedirá que o Batch possa executar novamente o StartTask.

Name Tipo Description
commandLine

string

A linha de comando do StartTask. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar 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 Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

As definições do contentor sob o qual a StartTask é executada. Quando isto é 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 para o contentor, todas as variáveis do ambiente Task são mapeadas para o contentor e a linha de comando Task é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

environmentSettings

EnvironmentSetting[]

Uma lista de configurações de variáveis de ambiente para o StartTask.

maxTaskRetryCount

integer (int32)

O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de tentativas. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço Batch não repetirá a Tarefa. Se a contagem máxima de tentativas for -1, o serviço em 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 tentativas).

resourceFiles

ResourceFile[]

Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Há um tamanho máximo para a lista de arquivos de recursos. 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 deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker. Os arquivos listados sob este elemento estão localizados no diretório de trabalho da tarefa.

userIdentity

UserIdentity

A identidade do utilizador sob a qual o StartTask é executado. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

waitForSuccess

boolean

Se o serviço em lote deve aguardar a conclusão bem-sucedida do StartTask (ou seja, sair com o código de saída 0) antes de agendar quaisquer tarefas no nó de computação. Se true e o StartTask falhar em um nó, o serviço Batch tentará novamente o StartTask até sua contagem máxima de tentativas (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as tentativas, o serviço Lote marcará o Nó como inutilizável e não agendará Tarefas para ele. Esta condição pode ser detetada através do estado do nó de computação e detalhes de informações de falha. Se false, o serviço Batch não aguardará a conclusão do StartTask. Nesse caso, outras tarefas podem começar a ser executadas no nó de computação enquanto o StartTask ainda está em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no nó de computação. O padrão é verdadeiro.

BatchStartTaskInfo

Informações sobre um StartTask em execução em um nó de computação.

Name Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Informação sobre o contentor sob o qual a Tarefa está a ser executada. Esta propriedade é definida apenas se a Tarefa for executada num contexto de contentor.

endTime

string (date-time)

A hora em que o StartTask deixou de funcionar. Esta é a hora de fim da execução mais recente do StartTask, se essa execução tiver sido concluída (mesmo que essa execução tenha falhado e uma nova tentativa esteja pendente). Este elemento não está presente se o StartTask estiver atualmente a correr.

exitCode

integer (int32)

O código de saída do programa especificado na linha de comandos StartTask. Esta propriedade só é definida se o StartTask estiver no estado concluído. Em geral, o código de saída de um processo reflete a convenção específica implementada pelo programador da aplicação para esse processo. Se usar o valor do código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção do código de saída usada pelo processo de candidatura. No entanto, se o serviço Batch terminar o StartTask (devido ao timeout ou à terminação do utilizador via API), pode aparecer um código de saída definido pelo sistema operativo.

failureInfo

BatchTaskFailureInfo

Informação que descreve a falha da Tarefa, se houver. Esta propriedade é definida apenas se a Tarefa estiver no estado concluído e tiver sofrido uma falha.

lastRetryTime

string (date-time)

A última vez em que uma nova tentativa da Tarefa começou a ser executada. Este elemento está presente apenas se a Tarefa foi retentada (ou seja, o retryCount for diferente de zero). Se presente, isto é tipicamente igual ao tempo de início, mas pode ser diferente se a tarefa tiver sido reiniciada por razões que não sejam retentar; por exemplo, se o Nó de Computação foi reiniciado durante uma retentativa, então o startTime é atualizado mas o lastRetryTime não.

result

BatchTaskExecutionResult

O resultado da execução da Tarefa. Se o valor for 'failed', então os detalhes da falha podem ser encontrados na propriedade failureInfo.

retryCount

integer (int32)

O número de vezes que a Tarefa foi retentada pelo serviço Batch. Falhas de aplicação de tarefas (código de saída não nulo) são retentadas, erros de pré-processamento (a tarefa não pôde ser executada) e erros de carregamento de ficheiros não são retentados. O serviço Batch tenta novamente a Tarefa até ao limite especificado pelas restrições.

startTime

string (date-time)

A hora em que o StartTask começou a ser executado. Este valor é reiniciado sempre que a Tarefa é reiniciada ou tentada novamente (ou seja, esta é a última vez em que a Tarefa de Início começou a ser executada).

state

BatchStartTaskState

O estado do StartTask no Nó de Computação.

BatchStartTaskState

Enums BatchStartTaskState

Valor Description
running

O StartTask está atualmente a correr.

completed

O StartTask saiu com o código de saída 0, ou o StartTask falhou e o limite de retentativas atingiu, ou o processo StartTask não foi executado devido a erros de preparação da Tarefa (como falhas no download de ficheiros de recursos).

BatchTaskContainerExecutionInfo

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

Name Tipo Description
containerId

string

A identificação do contentor.

error

string

Informação detalhada sobre o erro do contentor. Esta é a cadeia de erros detalhada do serviço Docker, se disponível. É equivalente ao campo de erro devolvido por "docker inspect".

state

string

O estado do contentor. Este é o estado do contentor segundo o serviço Docker. É equivalente ao campo de estado devolvido por "docker inspect".

BatchTaskContainerSettings

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

Name Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Os caminhos que você deseja montar para a 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.

containerRunOptions

string

Opções adicionais para o comando container create. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service.

imageName

string

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

registry

ContainerRegistryReference

O registo privado que contém a imagem do contentor. Esta definição pode ser omitida se já foi fornecida na criação do Pool.

workingDirectory

ContainerWorkingDirectory

A localização do diretório de trabalho da Tarefa do contentor. O padrão é 'taskWorkingDirectory'.

BatchTaskExecutionInfo

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

Name Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Informação sobre o contentor sob o qual a Tarefa está a ser executada. Esta propriedade é definida apenas se a Tarefa for executada num contexto de contentor.

endTime

string (date-time)

A hora em que a Tarefa foi concluída. Esta propriedade é definida apenas se a Tarefa estiver no estado Concluído.

exitCode

integer (int32)

O código de saída do programa especificado na linha de comandos Task. Esta propriedade é definida apenas se a Tarefa estiver no estado concluído. Em geral, o código de saída de um processo reflete a convenção específica implementada pelo programador da aplicação para esse processo. Se usar o valor do código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção do código de saída usada pelo processo de candidatura. No entanto, se o serviço Batch terminar a Tarefa (devido ao timeout ou à terminação do utilizador via API), pode aparecer um código de saída definido pelo sistema operativo.

failureInfo

BatchTaskFailureInfo

Informação que descreve a falha da Tarefa, se houver. Esta propriedade é definida apenas se a Tarefa estiver no estado concluído e tiver sofrido uma falha.

lastRequeueTime

string (date-time)

A última vez em que a Tarefa foi reenfileirada pelo serviço Batch como resultado de um pedido de utilizador. Esta propriedade é definida apenas se o requeueCount for diferente de zero.

lastRetryTime

string (date-time)

A última vez em que uma nova tentativa da Tarefa começou a ser executada. Este elemento está presente apenas se a Tarefa foi retentada (ou seja, o retryCount for diferente de zero). Se presente, isto é tipicamente igual ao tempo de início, mas pode ser diferente se a tarefa tiver sido reiniciada por razões que não sejam retentar; por exemplo, se o Nó de Computação foi reiniciado durante uma retentativa, então o startTime é atualizado mas o lastRetryTime não.

requeueCount

integer (int32)

O número de vezes que a Tarefa foi reenfileirada pelo serviço Batch como resultado de um pedido de utilizador. Quando o utilizador remove os Nós de Computação de um Pool (redimensionando/reduzindo o pool) ou quando o Job está a ser desativado, o utilizador pode especificar que as Tarefas em execução nos Compute Nodes sejam reenfileiradas para execução. Esta contagem regista quantas vezes a Tarefa foi recolocada na fila por estas razões.

result

BatchTaskExecutionResult

O resultado da execução da Tarefa. Se o valor for 'failed', então os detalhes da falha podem ser encontrados na propriedade failureInfo.

retryCount

integer (int32)

O número de vezes que a Tarefa foi retentada pelo serviço Batch. Falhas de aplicação de tarefas (código de saída não nulo) são retentadas, erros de pré-processamento (a tarefa não pôde ser executada) e erros de carregamento de ficheiros não são retentados. O serviço Batch tenta novamente a Tarefa até ao limite especificado pelas restrições.

startTime

string (date-time)

A hora em que a Tarefa começou a decorrer. 'Running' corresponde ao estado em execução, por isso, se a Tarefa especificar ficheiros de recursos ou Pacotes, então a hora de início reflete o momento em que a Tarefa começou a descarregar ou implementar estes. Se a Tarefa foi reiniciada ou retentada, esta é a última vez em que a Tarefa começou a ser executada. Esta propriedade está presente apenas para Tarefas que estejam no estado em execução ou concluídas.

BatchTaskExecutionResult

Enums BatchTaskExecutionResult

Valor Description
success

A Tarefa correu com sucesso.

failure

Houve um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo Tarefa ser lançado, enquanto o processo Tarefa estava em execução, ou depois de o processo Tarefa ter terminado.

BatchTaskFailureInfo

Informações sobre uma falha de tarefa.

Name Tipo Description
category

BatchErrorSourceCategory

A categoria do erro de tarefa.

code

string

Um identificador para o erro Tarefa. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

NameValuePair[]

Uma lista de detalhes adicionais relacionados com o erro.

message

string

Uma mensagem que descreve o erro Tarefa, destinada a ser adequada para exibição numa interface de utilizador.

BatchTaskInfo

Informações sobre uma tarefa em execução em um nó de computação.

Name Tipo Description
executionInfo

BatchTaskExecutionInfo

Informação sobre a execução da Tarefa.

jobId

string

O ID do Trabalho ao qual a Tarefa pertence.

subtaskId

integer (int32)

O ID da subtarefa se a tarefa for uma tarefa multi-instância.

taskId

string

A identificação da tarefa.

taskState

BatchTaskState

O estado atual da Tarefa.

taskUrl

string (uri)

O URL da tarefa.

BatchTaskState

Enums BatchTaskState

Valor Description
active

A Tarefa está em fila e pode ser executada, mas não está atualmente atribuída a um Nó de Computação. Uma Tarefa entra neste estado quando é criada, quando é ativada após ser desativada, ou quando aguarda uma nova tentativa após uma execução falhada.

preparing

A Tarefa foi atribuída a um Nó de Computação, mas está à espera que uma Tarefa de Preparação de Trabalho obrigatória seja concluída no Nó de Computação. Se a Tarefa de Preparação de Tarefas for bem-sucedida, a Tarefa passará para a corrida. Se a Tarefa de Preparação de Tarefas falhar, a Tarefa voltará a estar ativa e será elegível para ser atribuída a um Nó de Computação diferente.

running

A tarefa está a correr num nó de computação. Isto inclui preparação ao nível da tarefa, como o download de ficheiros de recursos ou a implementação de Pacotes especificados na Tarefa – não significa necessariamente que a linha de comandos da Tarefa tenha começado a executar.

completed

A Tarefa já não é elegível para ser executada, normalmente porque a Tarefa foi concluída com sucesso, ou porque a Tarefa foi concluída sem sucesso e esgotou o seu limite de retentativas. Uma tarefa também é marcada como concluída se ocorrer um erro ao iniciar a tarefa, ou quando a tarefa foi terminada.

BatchVmImageReference

Uma referência a uma Imagem do Azure Virtual Machines Marketplace ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de Imagem do Azure Marketplace verificadas pelo Azure Batch, consulte a operação ' Listar Imagens Suportadas '.

Name Tipo Description
communityGalleryImageId

string

A imagem da galeria comunitária identificador único. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida na chamada GET da galeria da comunidade.

exactVersion

string

A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Este campo de apenas leitura difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado for 'mais recente'.

offer

string

O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais Azure. Por exemplo, UbuntuServer ou WindowsServer.

publisher

string

O editor da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer.

sharedGalleryImageId

string

Identificador único da imagem da galeria partilhada. Esta propriedade é mutuamente exclusiva com outras propriedades e pode ser obtida a partir da chamada GET da imagem da galeria partilhada.

sku

string

O SKU da Imagem Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.

version

string

A versão da Imagem do Azure Virtual Machines Marketplace. Pode ser especificado um valor de 'mais recente' para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão é 'mais recente'.

virtualMachineImageId

string (arm-id)

O identificador de recurso ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Pool serão criados usando este ID de Imagem. Isto é da forma /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para usar sempre a versão mais recente da imagem. Esta propriedade é mutuamente exclusiva com outras propriedades do ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e deve estar na mesma subscrição da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, será usada a versão mais recente. Para informações sobre as definições do firewall do agente Batch Compute Node para comunicar com o serviço Batch, veja https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ContainerHostBatchBindMountEntry

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

Name Tipo Description
isReadOnly

boolean

Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). Para 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, 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 modificá-lo.

source

ContainerHostDataPath

O caminho que ser montado para o cliente de contêiner pode selecionar.

ContainerHostDataPath

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

Valor Description
Shared

O caminho para a tarefa de várias instâncias compartilhar seus arquivos.

Startup

O caminho para iniciar a tarefa.

VfsMounts

O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

Task

O caminho da tarefa.

JobPrep

O caminho da tarefa de preparação para o trabalho.

Applications

O caminho dos aplicativos.

ContainerRegistryReference

Um registro de contêiner privado.

Name Tipo Description
identityReference

BatchNodeIdentityReference

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

password

string (password)

A palavra-passe para iniciar sessão no servidor de registo.

registryServer

string (uri)

O URL do registo. Se omitido, o padrão é "docker.io".

username

string

O nome de utilizador para iniciar sessão no servidor de registo.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Valor Description
taskWorkingDirectory

Use o diretório de trabalho padrão de Tarefas do serviço Batch, que conterá os Ficheiros de Recursos da Tarefa preenchidos por Batch.

containerImageDefault

Use o diretório de trabalho definido na imagem do contentor. Atenção que este diretório não conterá os Ficheiros de Recursos descarregados pelo Batch.

ElevationLevel

Enums ElevationLevel

Valor Description
nonadmin

O usuário é um usuário padrão sem acesso elevado.

admin

O usuário é um usuário com acesso elevado e opera com permissões completas de administrador.

EnvironmentSetting

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

Name Tipo Description
name

string

O nome da variável de ambiente.

value

string

O valor da variável de ambiente.

InboundEndpoint

Um ponto de extremidade de entrada em um nó de computação.

Name Tipo Description
backendPort

integer (int32)

O número da porta backend do endpoint.

frontendPort

integer (int32)

O número da porta pública do endpoint.

name

string

O nome do ponto de extremidade.

protocol

InboundEndpointProtocol

O protocolo do ponto de extremidade.

publicFQDN

string

O domínio público totalmente qualificado para o Compute Node.

publicIPAddress

string

O endereço IP público do Nó de Computação.

InboundEndpointProtocol

InboundEndpointProtocol enums

Valor Description
tcp

Use TCP para o ponto de extremidade.

udp

Use UDP para o ponto de extremidade.

NameValuePair

Representa um par nome-valor.

Name Tipo Description
name

string

O nome no par nome-valor.

value

string

O valor no par nome-valor.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados para um nó de computação.

Name Tipo Description
autoStorageContainerName

string

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

blobPrefix

string

O prefixo de blob a ser usado ao baixar blobs de um contêiner de 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.

fileMode

string

O atributo file permission mode em formato octal. Esta propriedade aplica-se apenas a ficheiros descarregados para os Nós de Computação Linux. Será ignorado se for especificado para um resourceFile que será descarregado para um Nó de Computação do Windows. Se esta propriedade não for especificada para um Nó de Computação Linux, então é aplicado um valor padrão de 0770 ao ficheiro.

filePath

string

A localização no Nó de Computação para onde descarregar o(s) ficheiro(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 os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').

httpUrl

string (uri)

O URL do ficheiro a transferir. 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 a partir dos nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) 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.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo utilizador para aceder ao Azure Blob Storage especificada por storageContainerUrl ou httpUrl.

storageContainerUrl

string (uri)

A URL do contêiner de blob no Armazenamento de Blob do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável a partir 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 do contêiner para permitir acesso público.

SchedulingState

ProgramaçãoEstado enums

Valor Description
enabled

As tarefas podem ser agendadas no Nó de Computação.

disabled

Não serão agendadas novas Tarefas no Nó de Computação. As tarefas já a correr no Nó de Computação podem ainda ser executadas até à conclusão. Todos os Nós de Computação começam com o agendamento ativado.

UserIdentity

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

Name Tipo Description
autoUser

AutoUserSpecification

O utilizador 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.

username

string

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

VirtualMachineInfo

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

Name Tipo Description
imageReference

BatchVmImageReference

A referência à imagem Marketplace da Azure Virtual Machine.

scaleSetVmResourceId

string

O ID do recurso da VM atual do Conjunto de Escala da Máquina Virtual do Nó de Computação. Só definido se a Conta Batch foi criada com a propriedade poolAllocationMode definida como 'UserSubscription'.